aws_sdk_cloudformation/client/

create_stack_instances.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateStackInstances`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`stack_set_name(impl Into<String>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::stack_set_name) / [`set_stack_set_name(Option<String>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_stack_set_name):<br>required: **true**<br><p>The name or unique ID of the StackSet that you want to create stack instances from.</p><br>
    ///   - [`accounts(impl Into<String>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::accounts) / [`set_accounts(Option<Vec::<String>>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_accounts):<br>required: **false**<br><p>\[Self-managed permissions\] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p><br>
    ///   - [`deployment_targets(DeploymentTargets)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::deployment_targets) / [`set_deployment_targets(Option<DeploymentTargets>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_deployment_targets):<br>required: **false**<br><p>\[Service-managed permissions\] The Organizations accounts in which to create stack instances in the specified Amazon Web Services Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p><br>
    ///   - [`regions(impl Into<String>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::regions) / [`set_regions(Option<Vec::<String>>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_regions):<br>required: **true**<br><p>The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.</p><br>
    ///   - [`parameter_overrides(Parameter)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::parameter_overrides) / [`set_parameter_overrides(Option<Vec::<Parameter>>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_parameter_overrides):<br>required: **false**<br><p>A list of StackSet parameters whose values you want to override in the selected stack instances.</p> <p>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:</p> <ul>  <li>   <p>To override the current value for a parameter, include the parameter and specify its value.</p></li>  <li>   <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You can't specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p></li>  <li>   <p>To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don't include the parameter in the list.</p></li>  <li>   <p>To leave all parameters set to their present values, don't specify this property at all.</p></li> </ul> <p>During StackSet updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the StackSet; to add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the StackSet template.</p><br>
    ///   - [`operation_preferences(StackSetOperationPreferences)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::operation_preferences) / [`set_operation_preferences(Option<StackSetOperationPreferences>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_operation_preferences):<br>required: **false**<br><p>Preferences for how CloudFormation performs this StackSet operation.</p><br>
    ///   - [`operation_id(impl Into<String>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::operation_id) / [`set_operation_id(Option<String>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_operation_id):<br>required: **false**<br><p>The unique identifier for this StackSet operation.</p> <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically.</p> <p>Repeating this StackSet operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p><br>
    ///   - [`call_as(CallAs)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::call_as) / [`set_call_as(Option<CallAs>)`](crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::set_call_as):<br>required: **false**<br><p>\[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul>  <li>   <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>  <li>   <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>   <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li> </ul><br>
    /// - On success, responds with [`CreateStackInstancesOutput`](crate::operation::create_stack_instances::CreateStackInstancesOutput) with field(s):
    ///   - [`operation_id(Option<String>)`](crate::operation::create_stack_instances::CreateStackInstancesOutput::operation_id): <p>The unique identifier for this StackSet operation.</p>
    /// - On failure, responds with [`SdkError<CreateStackInstancesError>`](crate::operation::create_stack_instances::CreateStackInstancesError)
    pub fn create_stack_instances(&self) -> crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder {
        crate::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder::new(self.handle.clone())
    }
}