Struct aws_sdk_cloudformation::input::create_stack_instances_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateStackInstancesInput.

Implementations

impl Builder

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.

Examples found in repository

src/client.rs (line 2399)

        pub fn stack_set_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.stack_set_name(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2407)

        pub fn set_stack_set_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_stack_set_name(input);
            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 that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Examples found in repository

src/client.rs (line 2417)

        pub fn accounts(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.accounts(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2426)

        pub fn set_accounts(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_accounts(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2432)

        pub fn deployment_targets(mut self, input: crate::model::DeploymentTargets) -> Self {
            self.inner = self.inner.deployment_targets(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2441)

        pub fn set_deployment_targets(
            mut self,
            input: std::option::Option<crate::model::DeploymentTargets>,
        ) -> Self {
            self.inner = self.inner.set_deployment_targets(input);
            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 where you want to create stack instances using the specified Amazon Web Services accounts.

Examples found in repository

src/client.rs (line 2450)

        pub fn regions(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.regions(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2458)

        pub fn set_regions(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_regions(input);
            self
        }

pub fn parameter_overrides(self, input: Parameter) -> Self

Appends an item to parameter_overrides.

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.

Examples found in repository

src/client.rs (line 2476)

        pub fn parameter_overrides(mut self, input: crate::model::Parameter) -> Self {
            self.inner = self.inner.parameter_overrides(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2493)

        pub fn set_parameter_overrides(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Parameter>>,
        ) -> Self {
            self.inner = self.inner.set_parameter_overrides(input);
            self
        }

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

Preferences for how CloudFormation performs this stack set operation.

Examples found in repository

src/client.rs (line 2501)

        pub fn operation_preferences(
            mut self,
            input: crate::model::StackSetOperationPreferences,
        ) -> Self {
            self.inner = self.inner.operation_preferences(input);
            self
        }

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

Preferences for how CloudFormation performs this stack set operation.

Examples found in repository

src/client.rs (line 2509)

        pub fn set_operation_preferences(
            mut self,
            input: std::option::Option<crate::model::StackSetOperationPreferences>,
        ) -> Self {
            self.inner = self.inner.set_operation_preferences(input);
            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.

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

Examples found in repository

src/client.rs (line 2517)

        pub fn operation_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.operation_id(input.into());
            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.

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

Examples found in repository

src/client.rs (line 2525)

        pub fn set_operation_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_operation_id(input);
            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.

Examples found in repository

src/client.rs (line 2535)

        pub fn call_as(mut self, input: crate::model::CallAs) -> Self {
            self.inner = self.inner.call_as(input);
            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.

Examples found in repository

src/client.rs (line 2545)

        pub fn set_call_as(mut self, input: std::option::Option<crate::model::CallAs>) -> Self {
            self.inner = self.inner.set_call_as(input);
            self
        }

pub fn build(self) -> Result<CreateStackInstancesInput, BuildError>

Consumes the builder and constructs a CreateStackInstancesInput.

Examples found in repository

src/client.rs (line 2366)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateStackInstances,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateStackInstancesError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateStackInstancesOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateStackInstancesError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder