[ aws . proton ]

notify-resource-deployment-status-change

Description

Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles .

Warning

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  notify-resource-deployment-status-change
[--deployment-id <value>]
[--outputs <value>]
--resource-arn <value>
--status <value>
[--status-message <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--deployment-id (string)

The deployment ID for your provisioned resource.

--outputs (list)

The provisioned resource state change detail data that’s returned by Proton.

(structure)

An infrastructure as code defined resource output.

key -> (string)

The output key.

valueString -> (string)

The output value.

Shorthand Syntax:

key=string,valueString=string ...

JSON Syntax:

[
  {
    "key": "string",
    "valueString": "string"
  }
  ...
]

--resource-arn (string)

The provisioned resource Amazon Resource Name (ARN).

--status (string)

The status of your provisioned resource.

Possible values:

  • IN_PROGRESS

  • FAILED

  • SUCCEEDED

--status-message (string)

The deployment status message for your provisioned resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None