Struct aws_sdk_proton::client::fluent_builders::UpdateEnvironment

pub struct UpdateEnvironment { /* private fields */ }

Fluent builder constructing a request to UpdateEnvironment.

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.

Implementations

impl UpdateEnvironment

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdateEnvironment, AwsResponseRetryClassifier>, SdkError<UpdateEnvironmentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<UpdateEnvironmentOutput, SdkError<UpdateEnvironmentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the environment to update.

pub fn set_name(self, input: Option<String>) -> Self

The name of the environment to update.

pub fn description(self, input: impl Into<String>) -> Self

A description of the environment update.

pub fn set_description(self, input: Option<String>) -> Self

A description of the environment update.

pub fn spec(self, input: impl Into<String>) -> Self

The formatted specification that defines the update.

pub fn set_spec(self, input: Option<String>) -> Self

The formatted specification that defines the update.

pub fn template_major_version(self, input: impl Into<String>) -> Self

The major version of the environment to update.

pub fn set_template_major_version(self, input: Option<String>) -> Self

The major version of the environment to update.

pub fn template_minor_version(self, input: impl Into<String>) -> Self

The minor version of the environment to update.

pub fn set_template_minor_version(self, input: Option<String>) -> Self

The minor version of the environment to update.

pub fn proton_service_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_proton_service_role_arn(self, input: Option<String>) -> Self

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

pub fn deployment_type(self, input: DeploymentUpdateType) -> Self

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).

pub fn set_deployment_type(self, input: Option<DeploymentUpdateType>) -> Self

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).

pub fn environment_account_connection_id(self, input: impl Into<String>) -> Self

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.

pub fn set_environment_account_connection_id(self, input: Option<String>) -> Self

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.

pub fn provisioning_repository(self, input: RepositoryBranchInput) -> Self

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.

pub fn set_provisioning_repository(
    self,
    input: Option<RepositoryBranchInput>
) -> Self

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.

pub fn component_role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_component_role_arn(self, input: Option<String>) -> Self

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.

pub fn codebuild_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_codebuild_role_arn(self, input: Option<String>) -> Self

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

Trait Implementations

impl Clone for UpdateEnvironment

fn clone(&self) -> UpdateEnvironment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateEnvironment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.