Struct aws_sdk_cloudformation::operation::create_stack_instances::builders::CreateStackInstancesFluentBuilder

pub struct CreateStackInstancesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateStackInstances.

Creates 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 must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

Implementations

impl CreateStackInstancesFluentBuilder

pub fn as_input(&self) -> &CreateStackInstancesInputBuilder

Access the CreateStackInstances as a reference.

pub async fn send( self ) -> Result<CreateStackInstancesOutput, SdkError<CreateStackInstancesError, 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.

pub fn customize( self ) -> CustomizableOperation<CreateStackInstancesOutput, CreateStackInstancesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn stack_set_name(self, input: impl Into<String>) -> Self

The name or unique ID of the stack set that you want to create stack instances from.

pub fn set_stack_set_name(self, input: Option<String>) -> Self

The name or unique ID of the stack set that you want to create stack instances from.

pub fn get_stack_set_name(&self) -> &Option<String>

The name or unique ID of the stack set that you want to create stack instances from.

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 that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

pub fn set_accounts(self, input: Option<Vec<String>>) -> Self

[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.

pub fn get_accounts(&self) -> &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.

pub fn deployment_targets(self, input: DeploymentTargets) -> Self

[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.

pub fn set_deployment_targets(self, input: Option<DeploymentTargets>) -> Self

[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.

pub fn get_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.

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 where you want to create stack instances using the specified Amazon Web Services accounts.

pub fn set_regions(self, input: Option<Vec<String>>) -> Self

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

pub fn get_regions(&self) -> &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.

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 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 as true. (You can't specify both a value and set UsePreviousValue to true.)

• 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.

pub fn set_parameter_overrides(self, input: Option<Vec<Parameter>>) -> Self

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 as true. (You can't specify both a value and set UsePreviousValue to true.)

• 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.

pub fn get_parameter_overrides(&self) -> &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 as true. (You can't specify both a value and set UsePreviousValue to true.)

• 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.

pub fn operation_preferences(self, input: StackSetOperationPreferences) -> Self

Preferences for how CloudFormation performs this stack set operation.

pub fn set_operation_preferences( self, input: Option<StackSetOperationPreferences> ) -> Self

Preferences for how CloudFormation performs this stack set operation.

pub fn get_operation_preferences(&self) -> &Option<StackSetOperationPreferences>

Preferences for how CloudFormation performs this stack set operation.

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.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

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.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

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.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

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.

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.

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

impl Clone for CreateStackInstancesFluentBuilder

fn clone(&self) -> CreateStackInstancesFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateStackInstancesFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.