UpdateEnvironmentInput
¶
Source code in docs_src/capo_proton/types/update_environment_input.py
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.
deployment_type
instance-attribute
¶
deployment_type: DeploymentUpdateType
There are four modes for updating an environment. The deploymentType field defines the mode.
-
NONEIn this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
-
CURRENT_VERSIONIn this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this
deployment-type. -
MINOR_VERSIONIn this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
-
MAJOR_VERSIONIn this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
description
instance-attribute
¶
description: NotRequired[Description]
A description of the environment update.
environment_account_connection_id
instance-attribute
¶
environment_account_connection_id: NotRequired[EnvironmentAccountConnectionId]
The ID of the environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current 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 API calls to other services your behalf.
provisioning_repository
instance-attribute
¶
provisioning_repository: NotRequired[RepositoryBranchInput]
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 formatted specification that defines the update.
template_major_version
instance-attribute
¶
template_major_version: NotRequired[TemplateVersionPart]
The major version of the environment to update.
template_minor_version
instance-attribute
¶
template_minor_version: NotRequired[TemplateVersionPart]
The minor version of the environment to update.