Documentation

Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

See: newEnvironment smart constructor.

Create a value of Environment 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:codebuildRoleArn:Environment', environment_codebuildRoleArn - The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

$sel:componentRoleArn:Environment', environment_componentRoleArn - The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

$sel:deploymentStatusMessage:Environment', environment_deploymentStatusMessage - An environment deployment status message.

$sel:description:Environment', environment_description - The description of the environment.

$sel:environmentAccountConnectionId:Environment', environment_environmentAccountConnectionId - The ID of the environment account connection that's used to provision infrastructure resources in an environment account.

$sel:environmentAccountId:Environment', environment_environmentAccountId - The ID of the environment account that the environment infrastructure resources are provisioned in.

$sel:protonServiceRoleArn:Environment', environment_protonServiceRoleArn - The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

$sel:provisioning:Environment', environment_provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.

$sel:provisioningRepository:Environment', environment_provisioningRepository - The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

$sel:spec:Environment', environment_spec - The environment spec.

Environment, environment_arn - The Amazon Resource Name (ARN) of the environment.

$sel:createdAt:Environment', environment_createdAt - The time when the environment was created.

$sel:deploymentStatus:Environment', environment_deploymentStatus - The environment deployment status.

$sel:lastDeploymentAttemptedAt:Environment', environment_lastDeploymentAttemptedAt - The time when a deployment of the environment was last attempted.

$sel:lastDeploymentSucceededAt:Environment', environment_lastDeploymentSucceededAt - The time when the environment was last deployed successfully.

Environment, environment_name - The name of the environment.

$sel:templateMajorVersion:Environment', environment_templateMajorVersion - The major version of the environment template.

$sel:templateMinorVersion:Environment', environment_templateMinorVersion - The minor version of the environment template.

$sel:templateName:Environment', environment_templateName - The Amazon Resource Name (ARN) of the environment template.

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

An environment deployment status message.

The description of the environment.

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

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

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

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

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

The environment spec.

The Amazon Resource Name (ARN) of the environment.

The time when the environment was created.

The environment deployment status.

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

The time when the environment was last deployed successfully.

The name of the environment.

The major version of the environment template.

The minor version of the environment template.

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