aws_sdk_proton/client/

update_environment.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateEnvironment`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_name):<br>required: **true**<br><p>The name of the environment to update.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_description):<br>required: **false**<br><p>A description of the environment update.</p><br>
    ///   - [`spec(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::spec) / [`set_spec(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_spec):<br>required: **false**<br><p>The formatted specification that defines the update.</p><br>
    ///   - [`template_major_version(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::template_major_version) / [`set_template_major_version(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_template_major_version):<br>required: **false**<br><p>The major version of the environment to update.</p><br>
    ///   - [`template_minor_version(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::template_minor_version) / [`set_template_minor_version(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_template_minor_version):<br>required: **false**<br><p>The minor version of the environment to update.</p><br>
    ///   - [`proton_service_role_arn(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::proton_service_role_arn) / [`set_proton_service_role_arn(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_proton_service_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</p><br>
    ///   - [`deployment_type(DeploymentUpdateType)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::deployment_type) / [`set_deployment_type(Option<DeploymentUpdateType>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_deployment_type):<br>required: **true**<br><p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p> <dl>  <dt></dt>  <dd>   <p><code>NONE</code></p>   <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p>  </dd>  <dt></dt>  <dd>   <p><code>CURRENT_VERSION</code></p>   <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>  </dd>  <dt></dt>  <dd>   <p><code>MINOR_VERSION</code></p>   <p>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.</p>  </dd>  <dt></dt>  <dd>   <p><code>MAJOR_VERSION</code></p>   <p>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).</p>  </dd> </dl><br>
    ///   - [`environment_account_connection_id(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::environment_account_connection_id) / [`set_environment_account_connection_id(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_environment_account_connection_id):<br>required: **false**<br><p>The ID of the environment account connection.</p> <p>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.</p><br>
    ///   - [`provisioning_repository(RepositoryBranchInput)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::provisioning_repository) / [`set_provisioning_repository(Option<RepositoryBranchInput>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_provisioning_repository):<br>required: **false**<br><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 <code>CreateRepository</code>.</p><br>
    ///   - [`component_role_arn(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::component_role_arn) / [`set_component_role_arn(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_component_role_arn):<br>required: **false**<br><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><br>
    ///   - [`codebuild_role_arn(impl Into<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::codebuild_role_arn) / [`set_codebuild_role_arn(Option<String>)`](crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::set_codebuild_role_arn):<br>required: **false**<br><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><br>
    /// - On success, responds with [`UpdateEnvironmentOutput`](crate::operation::update_environment::UpdateEnvironmentOutput) with field(s):
    ///   - [`environment(Option<Environment>)`](crate::operation::update_environment::UpdateEnvironmentOutput::environment): <p>The environment detail data that's returned by Proton.</p>
    /// - On failure, responds with [`SdkError<UpdateEnvironmentError>`](crate::operation::update_environment::UpdateEnvironmentError)
    pub fn update_environment(&self) -> crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder {
        crate::operation::update_environment::builders::UpdateEnvironmentFluentBuilder::new(self.handle.clone())
    }
}