Documentation

Describes a deployment of a stack or app.

See: newDeployment smart constructor.

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:appId:Deployment', deployment_appId - The app ID.

$sel:command:Deployment', deployment_command - Used to specify a stack or deployment command.

$sel:comment:Deployment', deployment_comment - A user-defined comment.

$sel:completedAt:Deployment', deployment_completedAt - Date when the deployment completed.

$sel:createdAt:Deployment', deployment_createdAt - Date when the deployment was created.

$sel:customJson:Deployment', deployment_customJson - A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

$sel:deploymentId:Deployment', deployment_deploymentId - The deployment ID.

$sel:duration:Deployment', deployment_duration - The deployment duration.

$sel:iamUserArn:Deployment', deployment_iamUserArn - The user's IAM ARN.

$sel:instanceIds:Deployment', deployment_instanceIds - The IDs of the target instances.

$sel:stackId:Deployment', deployment_stackId - The stack ID.

$sel:status:Deployment', deployment_status - The deployment status:

• running
• successful
• failed

The app ID.

Used to specify a stack or deployment command.

A user-defined comment.

Date when the deployment completed.

Date when the deployment was created.

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

The deployment ID.

The deployment duration.

The user's IAM ARN.

The IDs of the target instances.

The stack ID.

The deployment status:

• running
• successful
• failed