#[non_exhaustive]pub struct UpdateStackInstancesInput {
pub stack_set_name: Option<String>,
pub accounts: Option<Vec<String>>,
pub deployment_targets: Option<DeploymentTargets>,
pub regions: Option<Vec<String>>,
pub parameter_overrides: Option<Vec<Parameter>>,
pub operation_preferences: Option<StackSetOperationPreferences>,
pub operation_id: Option<String>,
pub call_as: Option<CallAs>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stack_set_name: Option<String>
The name or unique ID of the stack set associated with the stack instances.
accounts: 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.
deployment_targets: 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.
regions: 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.
parameter_overrides: 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
.
operation_preferences: Option<StackSetOperationPreferences>
Preferences for how CloudFormation performs this stack set operation.
operation_id: 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.
call_as: 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.
Implementations§
source§impl UpdateStackInstancesInput
impl UpdateStackInstancesInput
sourcepub fn stack_set_name(&self) -> Option<&str>
pub fn stack_set_name(&self) -> Option<&str>
The name or unique ID of the stack set associated with the stack instances.
sourcepub fn accounts(&self) -> &[String]
pub fn accounts(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .accounts.is_none()
.
sourcepub fn deployment_targets(&self) -> Option<&DeploymentTargets>
pub fn 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) -> &[String]
pub fn regions(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .regions.is_none()
.
sourcepub fn parameter_overrides(&self) -> &[Parameter]
pub fn parameter_overrides(&self) -> &[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
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameter_overrides.is_none()
.
sourcepub fn operation_preferences(&self) -> Option<&StackSetOperationPreferences>
pub fn operation_preferences(&self) -> Option<&StackSetOperationPreferences>
Preferences for how CloudFormation performs this stack set operation.
sourcepub fn operation_id(&self) -> Option<&str>
pub fn operation_id(&self) -> Option<&str>
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) -> Option<&CallAs>
pub fn 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.
source§impl UpdateStackInstancesInput
impl UpdateStackInstancesInput
sourcepub fn builder() -> UpdateStackInstancesInputBuilder
pub fn builder() -> UpdateStackInstancesInputBuilder
Creates a new builder-style object to manufacture UpdateStackInstancesInput
.
Trait Implementations§
source§impl Clone for UpdateStackInstancesInput
impl Clone for UpdateStackInstancesInput
source§fn clone(&self) -> UpdateStackInstancesInput
fn clone(&self) -> UpdateStackInstancesInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateStackInstancesInput
impl Debug for UpdateStackInstancesInput
source§impl PartialEq for UpdateStackInstancesInput
impl PartialEq for UpdateStackInstancesInput
source§fn eq(&self, other: &UpdateStackInstancesInput) -> bool
fn eq(&self, other: &UpdateStackInstancesInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UpdateStackInstancesInput
Auto Trait Implementations§
impl Freeze for UpdateStackInstancesInput
impl RefUnwindSafe for UpdateStackInstancesInput
impl Send for UpdateStackInstancesInput
impl Sync for UpdateStackInstancesInput
impl Unpin for UpdateStackInstancesInput
impl UnwindSafe for UpdateStackInstancesInput
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