Update Component

proton_update_component

R Documentation

Update a component

Description

Update a component.

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

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

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

Usage

proton_update_component(clientToken, deploymentType, description, name,
  serviceInstanceName, serviceName, serviceSpec, templateFile)

Arguments

clientToken

The client token for the updated component.

deploymentType

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

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

CURRENT_VERSION

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

description

An optional customer-provided description of the component.

name

[required] The name of the component to update.

serviceInstanceName

The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

serviceName

The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

serviceSpec

The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

templateFile

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

Value

A list with the following syntax:

list(
  component = 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",
    description = "string",
    environmentName = "string",
    lastAttemptedDeploymentId = "string",
    lastClientRequestToken = "string",
    lastDeploymentAttemptedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastDeploymentSucceededAt = as.POSIXct(
      "2015-01-01"
    ),
    lastModifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastSucceededDeploymentId = "string",
    name = "string",
    serviceInstanceName = "string",
    serviceName = "string",
    serviceSpec = "string"
  )
)

Request syntax

svc$update_component(
  clientToken = "string",
  deploymentType = "NONE"|"CURRENT_VERSION",
  description = "string",
  name = "string",
  serviceInstanceName = "string",
  serviceName = "string",
  serviceSpec = "string",
  templateFile = "string"
)