pub struct UpdateEnvironmentFluentBuilder { /* private fields */ }
Expand description
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§
Source§impl UpdateEnvironmentFluentBuilder
impl UpdateEnvironmentFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateEnvironmentInputBuilder
pub fn as_input(&self) -> &UpdateEnvironmentInputBuilder
Access the UpdateEnvironment as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateEnvironmentOutput, SdkError<UpdateEnvironmentError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateEnvironmentOutput, SdkError<UpdateEnvironmentError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateEnvironmentOutput, UpdateEnvironmentError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateEnvironmentOutput, UpdateEnvironmentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the environment update.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the environment update.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the environment update.
Sourcepub fn spec(self, input: impl Into<String>) -> Self
pub fn spec(self, input: impl Into<String>) -> Self
The formatted specification that defines the update.
Sourcepub fn set_spec(self, input: Option<String>) -> Self
pub fn set_spec(self, input: Option<String>) -> Self
The formatted specification that defines the update.
Sourcepub fn template_major_version(self, input: impl Into<String>) -> Self
pub fn template_major_version(self, input: impl Into<String>) -> Self
The major version of the environment to update.
Sourcepub fn set_template_major_version(self, input: Option<String>) -> Self
pub fn set_template_major_version(self, input: Option<String>) -> Self
The major version of the environment to update.
Sourcepub fn get_template_major_version(&self) -> &Option<String>
pub fn get_template_major_version(&self) -> &Option<String>
The major version of the environment to update.
Sourcepub fn template_minor_version(self, input: impl Into<String>) -> Self
pub fn template_minor_version(self, input: impl Into<String>) -> Self
The minor version of the environment to update.
Sourcepub fn set_template_minor_version(self, input: Option<String>) -> Self
pub fn set_template_minor_version(self, input: Option<String>) -> Self
The minor version of the environment to update.
Sourcepub fn get_template_minor_version(&self) -> &Option<String>
pub fn get_template_minor_version(&self) -> &Option<String>
The minor version of the environment to update.
Sourcepub fn proton_service_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_proton_service_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_proton_service_role_arn(&self) -> &Option<String>
pub fn get_proton_service_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
Sourcepub fn deployment_type(self, input: DeploymentUpdateType) -> Self
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).
Sourcepub fn set_deployment_type(self, input: Option<DeploymentUpdateType>) -> Self
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).
Sourcepub fn get_deployment_type(&self) -> &Option<DeploymentUpdateType>
pub fn get_deployment_type(&self) -> &Option<DeploymentUpdateType>
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).
Sourcepub fn environment_account_connection_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_environment_account_connection_id(
self,
input: Option<String>,
) -> Self
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.
Sourcepub fn get_environment_account_connection_id(&self) -> &Option<String>
pub fn get_environment_account_connection_id(&self) -> &Option<String>
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.
Sourcepub fn provisioning_repository(self, input: RepositoryBranchInput) -> Self
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
.
Sourcepub fn set_provisioning_repository(
self,
input: Option<RepositoryBranchInput>,
) -> Self
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
.
Sourcepub fn get_provisioning_repository(&self) -> &Option<RepositoryBranchInput>
pub fn get_provisioning_repository(&self) -> &Option<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
.
Sourcepub fn component_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_component_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_component_role_arn(&self) -> &Option<String>
pub fn get_component_role_arn(&self) -> &Option<String>
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.
Sourcepub fn codebuild_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_codebuild_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_codebuild_role_arn(&self) -> &Option<String>
pub fn get_codebuild_role_arn(&self) -> &Option<String>
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§
Source§impl Clone for UpdateEnvironmentFluentBuilder
impl Clone for UpdateEnvironmentFluentBuilder
Source§fn clone(&self) -> UpdateEnvironmentFluentBuilder
fn clone(&self) -> UpdateEnvironmentFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateEnvironmentFluentBuilder
impl !RefUnwindSafe for UpdateEnvironmentFluentBuilder
impl Send for UpdateEnvironmentFluentBuilder
impl Sync for UpdateEnvironmentFluentBuilder
impl Unpin for UpdateEnvironmentFluentBuilder
impl !UnwindSafe for UpdateEnvironmentFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);