Skip to content

Environment

Source code in docs_src/capo_proton/types/environment.py
class Environment(TypedDict, closed=True):
    name: "capo_proton.types.resource_name.ResourceName"
    """<p>The name of the environment.</p>"""
    description: NotRequired["capo_proton.types.description.Description"]
    """<p>The description of the environment.</p>"""
    created_at: "datetime.datetime"
    """<p>The time when the environment was created.</p>"""
    last_deployment_attempted_at: "datetime.datetime"
    """<p>The time when a deployment of the environment was last attempted.</p>"""
    last_deployment_succeeded_at: "datetime.datetime"
    """<p>The time when the environment was last deployed successfully.</p>"""
    arn: "capo_proton.types.environment_arn.EnvironmentArn"
    """<p>The Amazon Resource Name (ARN) of the environment.</p>"""
    template_name: "capo_proton.types.resource_name.ResourceName"
    """<p>The Amazon Resource Name (ARN) of the environment template.</p>"""
    template_major_version: (
        "capo_proton.types.template_version_part.TemplateVersionPart"
    )
    """<p>The major version of the environment template.</p>"""
    template_minor_version: (
        "capo_proton.types.template_version_part.TemplateVersionPart"
    )
    """<p>The minor version of the environment template.</p>"""
    deployment_status: "capo_proton.types.deployment_status.DeploymentStatus"
    """<p>The environment deployment status.</p>"""
    deployment_status_message: NotRequired[
        "capo_proton.types.status_message.StatusMessage"
    ]
    """<p>An environment deployment status message.</p>"""
    proton_service_role_arn: NotRequired["capo_proton.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.</p>"""
    environment_account_connection_id: NotRequired[
        "capo_proton.types.environment_account_connection_id.EnvironmentAccountConnectionId"
    ]
    """<p>The ID of the environment account connection that's used to provision infrastructure resources in an environment account.</p>"""
    environment_account_id: NotRequired["capo_proton.types.aws_account_id.AwsAccountId"]
    """<p>The ID of the environment account that the environment infrastructure resources are provisioned in.</p>"""
    spec: NotRequired["capo_proton.types.spec_contents.SpecContents"]
    """<p>The environment spec.</p>"""
    provisioning: NotRequired["capo_proton.types.provisioning.Provisioning"]
    """<p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>"""
    provisioning_repository: NotRequired[
        "capo_proton.types.repository_branch.RepositoryBranch"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html">CreateRepository</a>.</p>"""
    component_role_arn: NotRequired["capo_proton.types.role_arn.RoleArn"]
    """<p>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.</p> <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>"""
    codebuild_role_arn: NotRequired["capo_proton.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.</p>"""
    last_attempted_deployment_id: NotRequired[
        "capo_proton.types.deployment_id.DeploymentId"
    ]
    """<p>The ID of the last attempted deployment of this environment.</p>"""
    last_succeeded_deployment_id: NotRequired[
        "capo_proton.types.deployment_id.DeploymentId"
    ]
    """<p>The ID of the last successful deployment of this environment.</p>"""

arn instance-attribute

The Amazon Resource Name (ARN) of the environment.

codebuild_role_arn instance-attribute

codebuild_role_arn: NotRequired[RoleArn]

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

component_role_arn instance-attribute

component_role_arn: NotRequired[RoleArn]

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.

created_at instance-attribute

created_at: datetime

The time when the environment was created.

deployment_status instance-attribute

deployment_status: DeploymentStatus

The environment deployment status.

deployment_status_message instance-attribute

deployment_status_message: NotRequired[StatusMessage]

An environment deployment status message.

description instance-attribute

description: NotRequired[Description]

The description of the environment.

environment_account_connection_id instance-attribute

environment_account_connection_id: NotRequired[EnvironmentAccountConnectionId]

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

environment_account_id instance-attribute

environment_account_id: NotRequired[AwsAccountId]

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

last_attempted_deployment_id instance-attribute

last_attempted_deployment_id: NotRequired[DeploymentId]

The ID of the last attempted deployment of this environment.

last_deployment_attempted_at instance-attribute

last_deployment_attempted_at: datetime

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

last_deployment_succeeded_at instance-attribute

last_deployment_succeeded_at: datetime

The time when the environment was last deployed successfully.

last_succeeded_deployment_id instance-attribute

last_succeeded_deployment_id: NotRequired[DeploymentId]

The ID of the last successful deployment of this environment.

name instance-attribute

The name of the environment.

proton_service_role_arn instance-attribute

proton_service_role_arn: NotRequired[Arn]

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

provisioning instance-attribute

provisioning: NotRequired[Provisioning]

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

provisioning_repository instance-attribute

provisioning_repository: NotRequired[RepositoryBranch]

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.

spec instance-attribute

spec: NotRequired[SpecContents]

The environment spec.

template_major_version instance-attribute

template_major_version: TemplateVersionPart

The major version of the environment template.

template_minor_version instance-attribute

template_minor_version: TemplateVersionPart

The minor version of the environment template.

template_name instance-attribute

template_name: ResourceName

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