Update Environment
proton_update_environment | R Documentation |
Update an environment¶
Description¶
Update an environment.
If the environment is associated with an environment account connection,
don't update or include the protonServiceRoleArn
and
provisioningRepository
parameter to update or connect to an
environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account
connection, don't update or include the
environmentAccountConnectionId
parameter. You can't update or
connect the environment to an environment account connection if it
isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId
or
protonServiceRoleArn
parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed
provisioning, omit the provisioningRepository
parameter.
If the environment was configured for self-managed provisioning, specify
the provisioningRepository
parameter and omit the
protonServiceRoleArn
and environmentAccountConnectionId
parameters.
For more information, see Environments and Provisioning methods in the Proton User Guide.
There are four modes for updating an environment. The deploymentType
field defines the mode.
¶
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
¶
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec
that you provide. Only requested parameters are updated. Don’t include
minor or major version parameters when you use this deployment-type
.
¶
MINOR_VERSION
In 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_VERSION
In 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's higher than the major version in use and a minor version.
Usage¶
proton_update_environment(codebuildRoleArn, componentRoleArn,
deploymentType, description, environmentAccountConnectionId, name,
protonServiceRoleArn, provisioningRepository, spec,
templateMajorVersion, templateMinorVersion)
Arguments¶
codebuildRoleArn
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
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.
deploymentType
[required] There are four modes for updating an environment. The
deploymentType
field defines the mode.NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In 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_VERSION
In 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_VERSION
In 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
A description of the environment update.
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.
name
[required] The name of the environment to update.
protonServiceRoleArn
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
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
create_repository
.spec
The formatted specification that defines the update.
templateMajorVersion
The major version of the environment to update.
templateMinorVersion
The minor version of the environment to update.
Value¶
A list with the following syntax:
list(
environment = list(
arn = "string",
codebuildRoleArn = "string",
componentRoleArn = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
deploymentStatus = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"CANCELLING"|"CANCELLED",
deploymentStatusMessage = "string",
description = "string",
environmentAccountConnectionId = "string",
environmentAccountId = "string",
lastAttemptedDeploymentId = "string",
lastDeploymentAttemptedAt = as.POSIXct(
"2015-01-01"
),
lastDeploymentSucceededAt = as.POSIXct(
"2015-01-01"
),
lastSucceededDeploymentId = "string",
name = "string",
protonServiceRoleArn = "string",
provisioning = "CUSTOMER_MANAGED",
provisioningRepository = list(
arn = "string",
branch = "string",
name = "string",
provider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
),
spec = "string",
templateMajorVersion = "string",
templateMinorVersion = "string",
templateName = "string"
)
)
Request syntax¶
svc$update_environment(
codebuildRoleArn = "string",
componentRoleArn = "string",
deploymentType = "NONE"|"CURRENT_VERSION"|"MINOR_VERSION"|"MAJOR_VERSION",
description = "string",
environmentAccountConnectionId = "string",
name = "string",
protonServiceRoleArn = "string",
provisioningRepository = list(
branch = "string",
name = "string",
provider = "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
),
spec = "string",
templateMajorVersion = "string",
templateMinorVersion = "string"
)