Environment - AWS Proton

Environment

The environment detail data. An AWS Proton environment is a set resources shared across an AWS Proton service.

Contents

arn

The Amazon Resource Name (ARN) of the environment.

Type: String

Required: Yes

createdAt

The time when the environment was created.

Type: Timestamp

Required: Yes

deploymentStatus

The environment deployment status.

Type: String

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

Required: Yes

deploymentStatusMessage

An environment deployment status message.

Type: String

Required: No

description

The description of the environment.

Type: String

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

Required: No

environmentAccountConnectionId

The ID of the environment account connection that's used to provision infrastructure resources in an environment account.

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: No

environmentAccountId

The ID of the environment account that the environment infrastructure resources are provisioned in.

Type: String

Pattern: ^\d{12}$

Required: No

lastDeploymentAttemptedAt

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

Type: Timestamp

Required: Yes

lastDeploymentSucceededAt

The time when the environment was last deployed successfully.

Type: Timestamp

Required: Yes

name

The name of the environment.

Type: String

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

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

Required: Yes

protonServiceRoleArn

The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.

Type: String

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

Required: No

provisioning

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

Type: String

Valid Values: CUSTOMER_MANAGED

Required: No

provisioningRepository

The repository that you provide with pull request provisioning.

Important

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

Type: RepositoryBranch object

Required: No

spec

The environment spec.

Type: String

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

Required: No

templateMajorVersion

The major version of the environment template.

Type: String

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

Pattern: ^(0|([1-9]{1}\d*))$

Required: Yes

templateMinorVersion

The minor version of the environment template.

Type: String

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

Pattern: ^(0|([1-9]{1}\d*))$

Required: Yes

templateName

The Amazon Resource Name (ARN) of the environment template.

Type: String

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

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

Required: Yes

See Also

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