proton_update_environment: Update an environment

Description

Update an environment.

See https://www.paws-r-sdk.com/docs/proton_update_environment/ for full documentation.

Usage

proton_update_environment(
  codebuildRoleArn = NULL,
  componentRoleArn = NULL,
  deploymentType,
  description = NULL,
  environmentAccountConnectionId = NULL,
  name,
  protonServiceRoleArn = NULL,
  provisioningRepository = NULL,
  spec = NULL,
  templateMajorVersion = NULL,
  templateMinorVersion = NULL
)

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.