#[non_exhaustive]pub struct CreateStackInstancesInput {
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 that you want to create stack instances from.
accounts: Option<Vec<String>>
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
deployment_targets: Option<DeploymentTargets>
[Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
regions: Option<Vec<String>>
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.
parameter_overrides: Option<Vec<Parameter>>
A list of stack set parameters whose values you want to override in the selected 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 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.
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.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED
.
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 CreateStackInstancesInput
impl CreateStackInstancesInput
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 that you want to create stack instances from.
sourcepub fn accounts(&self) -> &[String]
pub fn accounts(&self) -> &[String]
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
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 to create stack instances in the specified Amazon Web Services Regions.
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 where you want to create stack instances using the specified Amazon Web Services accounts.
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 stack set parameters whose values you want to override in the selected 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 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 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.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED
.
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 CreateStackInstancesInput
impl CreateStackInstancesInput
sourcepub fn builder() -> CreateStackInstancesInputBuilder
pub fn builder() -> CreateStackInstancesInputBuilder
Creates a new builder-style object to manufacture CreateStackInstancesInput
.
Trait Implementations§
source§impl Clone for CreateStackInstancesInput
impl Clone for CreateStackInstancesInput
source§fn clone(&self) -> CreateStackInstancesInput
fn clone(&self) -> CreateStackInstancesInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateStackInstancesInput
impl Debug for CreateStackInstancesInput
source§impl PartialEq for CreateStackInstancesInput
impl PartialEq for CreateStackInstancesInput
source§fn eq(&self, other: &CreateStackInstancesInput) -> bool
fn eq(&self, other: &CreateStackInstancesInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateStackInstancesInput
Auto Trait Implementations§
impl Freeze for CreateStackInstancesInput
impl RefUnwindSafe for CreateStackInstancesInput
impl Send for CreateStackInstancesInput
impl Sync for CreateStackInstancesInput
impl Unpin for CreateStackInstancesInput
impl UnwindSafe for CreateStackInstancesInput
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