Component - AWS Proton

Component

Detailed data of an AWS Proton component resource.

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

Contents

arn

The Amazon Resource Name (ARN) of the component.

Type: String

Required: Yes

createdAt

The time when the component was created.

Type: Timestamp

Required: Yes

deploymentStatus

The component deployment status.

Type: String

Valid Values: IN_PROGRESS | FAILED | SUCCEEDED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | CANCELLING | CANCELLED

Required: Yes

deploymentStatusMessage

The message associated with the component deployment status.

Type: String

Required: No

description

A description of the component.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

environmentName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

lastDeploymentAttemptedAt

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

Type: Timestamp

Required: No

lastDeploymentSucceededAt

The time when the component was last deployed successfully.

Type: Timestamp

Required: No

lastModifiedAt

The time when the component was last modified.

Type: Timestamp

Required: Yes

name

The name of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

serviceInstanceName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

serviceName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

serviceSpec

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: