AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . proton ]

update-component

Description

Update a component.

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

Note

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 .

See also: AWS API Documentation

Synopsis

  update-component
[--client-token <value>]
--deployment-type <value>
[--description <value>]
--name <value>
[--service-instance-name <value>]
[--service-name <value>]
[--service-spec <value>]
[--template-file <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--client-token (string)

The client token for the updated component.

--deployment-type (string)

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.

Possible values:

  • NONE
  • CURRENT_VERSION

--description (string)

An optional customer-provided description of the component.

--name (string)

The name of the component to update.

--service-instance-name (string)

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.

--service-name (string)

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.

--service-spec (string)

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.

--template-file (string)

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

Note

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

component -> (structure)

The detailed data of the updated component.

arn -> (string)

The Amazon Resource Name (ARN) of the component.

createdAt -> (timestamp)

The time when the component was created.

deploymentStatus -> (string)

The component deployment status.

deploymentStatusMessage -> (string)

The message associated with the component deployment status.

description -> (string)

A description of the component.

environmentName -> (string)

The name of the Proton environment that this component is associated with.

lastAttemptedDeploymentId -> (string)

The ID of the last attempted deployment of this component.

lastClientRequestToken -> (string)

The last token the client requested.

lastDeploymentAttemptedAt -> (timestamp)

The time when a deployment of the component was last attempted.

lastDeploymentSucceededAt -> (timestamp)

The time when the component was last deployed successfully.

lastModifiedAt -> (timestamp)

The time when the component was last modified.

lastSucceededDeploymentId -> (string)

The ID of the last successful deployment of this component.

name -> (string)

The name of the component.

serviceInstanceName -> (string)

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

serviceName -> (string)

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

serviceSpec -> (string)

The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.