Update Service Instance

proton_update_service_instance

R Documentation

Update a service instance

Description

Update a service instance.

There are a few modes for updating a service instance. The deploymentType field defines the mode.

You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton User Guide.

Usage

proton_update_service_instance(clientToken, deploymentType, name,
  serviceName, spec, templateMajorVersion, templateMinorVersion)

Arguments

clientToken

The client token of the service instance to update.

deploymentType

[required] The deployment type. It defines the mode for updating a service instance, as follows:

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment type.

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

name

[required] The name of the service instance to update.

serviceName

[required] The name of the service that the service instance belongs to.

spec

The formatted specification that defines the service instance update.

templateMajorVersion

The major version of the service template to update.

templateMinorVersion

The minor version of the service template to update.

Value

A list with the following syntax:

list(
  serviceInstance = list(
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    deploymentStatus = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"CANCELLING"|"CANCELLED",
    deploymentStatusMessage = "string",
    environmentName = "string",
    lastAttemptedDeploymentId = "string",
    lastClientRequestToken = "string",
    lastDeploymentAttemptedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastDeploymentSucceededAt = as.POSIXct(
      "2015-01-01"
    ),
    lastSucceededDeploymentId = "string",
    name = "string",
    serviceName = "string",
    spec = "string",
    templateMajorVersion = "string",
    templateMinorVersion = "string",
    templateName = "string"
  )
)

Request syntax

svc$update_service_instance(
  clientToken = "string",
  deploymentType = "NONE"|"CURRENT_VERSION"|"MINOR_VERSION"|"MAJOR_VERSION",
  name = "string",
  serviceName = "string",
  spec = "string",
  templateMajorVersion = "string",
  templateMinorVersion = "string"
)