Struct aws_sdk_cloudformation::operation::update_stack_instances::builders::UpdateStackInstancesFluentBuilder
source · pub struct UpdateStackInstancesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateStackInstances
.
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances
.
Implementations§
source§impl UpdateStackInstancesFluentBuilder
impl UpdateStackInstancesFluentBuilder
sourcepub fn as_input(&self) -> &UpdateStackInstancesInputBuilder
pub fn as_input(&self) -> &UpdateStackInstancesInputBuilder
Access the UpdateStackInstances as a reference.
sourcepub async fn send(
self
) -> Result<UpdateStackInstancesOutput, SdkError<UpdateStackInstancesError, HttpResponse>>
pub async fn send( self ) -> Result<UpdateStackInstancesOutput, SdkError<UpdateStackInstancesError, 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<UpdateStackInstancesOutput, UpdateStackInstancesError, Self>
pub fn customize( self ) -> CustomizableOperation<UpdateStackInstancesOutput, UpdateStackInstancesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stack_set_name(self, input: impl Into<String>) -> Self
pub fn stack_set_name(self, input: impl Into<String>) -> Self
The name or unique ID of the stack set associated with the stack instances.
sourcepub fn set_stack_set_name(self, input: Option<String>) -> Self
pub fn set_stack_set_name(self, input: Option<String>) -> Self
The name or unique ID of the stack set associated with the stack instances.
sourcepub fn get_stack_set_name(&self) -> &Option<String>
pub fn get_stack_set_name(&self) -> &Option<String>
The name or unique ID of the stack set associated with the stack instances.
sourcepub fn accounts(self, input: impl Into<String>) -> Self
pub fn accounts(self, input: impl Into<String>) -> Self
Appends an item to Accounts
.
To override the contents of this collection use set_accounts
.
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
sourcepub fn set_accounts(self, input: Option<Vec<String>>) -> Self
pub fn set_accounts(self, input: Option<Vec<String>>) -> Self
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
sourcepub fn get_accounts(&self) -> &Option<Vec<String>>
pub fn get_accounts(&self) -> &Option<Vec<String>>
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
sourcepub fn deployment_targets(self, input: DeploymentTargets) -> Self
pub fn deployment_targets(self, input: DeploymentTargets) -> Self
[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.
You can specify Accounts
or DeploymentTargets
, but not both.
sourcepub fn set_deployment_targets(self, input: Option<DeploymentTargets>) -> Self
pub fn set_deployment_targets(self, input: Option<DeploymentTargets>) -> Self
[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.
You can specify Accounts
or DeploymentTargets
, but not both.
sourcepub fn get_deployment_targets(&self) -> &Option<DeploymentTargets>
pub fn get_deployment_targets(&self) -> &Option<DeploymentTargets>
[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.
You can specify Accounts
or DeploymentTargets
, but not both.
sourcepub fn regions(self, input: impl Into<String>) -> Self
pub fn regions(self, input: impl Into<String>) -> Self
Appends an item to Regions
.
To override the contents of this collection use set_regions
.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
sourcepub fn set_regions(self, input: Option<Vec<String>>) -> Self
pub fn set_regions(self, input: Option<Vec<String>>) -> Self
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
sourcepub fn get_regions(&self) -> &Option<Vec<String>>
pub fn get_regions(&self) -> &Option<Vec<String>>
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.
sourcepub fn parameter_overrides(self, input: Parameter) -> Self
pub fn parameter_overrides(self, input: Parameter) -> Self
Appends an item to ParameterOverrides
.
To override the contents of this collection use set_parameter_overrides
.
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
-
To override the current value for a parameter, include the parameter and specify its value.
-
To leave an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
astrue
. (You can't specify both a value and setUsePreviousValue
totrue
.) -
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
-
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet
to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances
.
sourcepub fn set_parameter_overrides(self, input: Option<Vec<Parameter>>) -> Self
pub fn set_parameter_overrides(self, input: Option<Vec<Parameter>>) -> Self
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
-
To override the current value for a parameter, include the parameter and specify its value.
-
To leave an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
astrue
. (You can't specify both a value and setUsePreviousValue
totrue
.) -
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
-
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet
to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances
.
sourcepub fn get_parameter_overrides(&self) -> &Option<Vec<Parameter>>
pub fn get_parameter_overrides(&self) -> &Option<Vec<Parameter>>
A list of input parameters whose values you want to update for the specified stack instances.
Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:
-
To override the current value for a parameter, include the parameter and specify its value.
-
To leave an overridden parameter set to its present value, include the parameter and specify
UsePreviousValue
astrue
. (You can't specify both a value and setUsePreviousValue
totrue
.) -
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
-
To leave all parameters set to their present values, don't specify this property at all.
During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.
You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet
to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances
.
sourcepub fn operation_preferences(self, input: StackSetOperationPreferences) -> Self
pub fn operation_preferences(self, input: StackSetOperationPreferences) -> Self
Preferences for how CloudFormation performs this stack set operation.
sourcepub fn set_operation_preferences(
self,
input: Option<StackSetOperationPreferences>
) -> Self
pub fn set_operation_preferences( self, input: Option<StackSetOperationPreferences> ) -> Self
Preferences for how CloudFormation performs this stack set operation.
sourcepub fn get_operation_preferences(&self) -> &Option<StackSetOperationPreferences>
pub fn get_operation_preferences(&self) -> &Option<StackSetOperationPreferences>
Preferences for how CloudFormation performs this stack set operation.
sourcepub fn operation_id(self, input: impl Into<String>) -> Self
pub fn operation_id(self, input: impl Into<String>) -> Self
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
sourcepub fn set_operation_id(self, input: Option<String>) -> Self
pub fn set_operation_id(self, input: Option<String>) -> Self
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
sourcepub fn get_operation_id(&self) -> &Option<String>
pub fn get_operation_id(&self) -> &Option<String>
The unique identifier for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
sourcepub fn call_as(self, input: CallAs) -> Self
pub fn call_as(self, input: CallAs) -> Self
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF
is specified. Use SELF
for stack sets with self-managed permissions.
-
If you are signed in to the management account, specify
SELF
. -
If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN
.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
sourcepub fn set_call_as(self, input: Option<CallAs>) -> Self
pub fn set_call_as(self, input: Option<CallAs>) -> Self
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF
is specified. Use SELF
for stack sets with self-managed permissions.
-
If you are signed in to the management account, specify
SELF
. -
If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN
.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
sourcepub fn get_call_as(&self) -> &Option<CallAs>
pub fn get_call_as(&self) -> &Option<CallAs>
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF
is specified. Use SELF
for stack sets with self-managed permissions.
-
If you are signed in to the management account, specify
SELF
. -
If you are signed in to a delegated administrator account, specify
DELEGATED_ADMIN
.Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
Trait Implementations§
source§impl Clone for UpdateStackInstancesFluentBuilder
impl Clone for UpdateStackInstancesFluentBuilder
source§fn clone(&self) -> UpdateStackInstancesFluentBuilder
fn clone(&self) -> UpdateStackInstancesFluentBuilder
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 UpdateStackInstancesFluentBuilder
impl !RefUnwindSafe for UpdateStackInstancesFluentBuilder
impl Send for UpdateStackInstancesFluentBuilder
impl Sync for UpdateStackInstancesFluentBuilder
impl Unpin for UpdateStackInstancesFluentBuilder
impl !UnwindSafe for UpdateStackInstancesFluentBuilder
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> 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 more