Struct aws_sdk_cloudformation::input::create_stack_set_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateStackSetInput.

Implementations

impl Builder

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Examples found in repository

src/client.rs (line 2615)

        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 to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Examples found in repository

src/client.rs (line 2625)

        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 description(self, input: impl Into<String>) -> Self

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Examples found in repository

src/client.rs (line 2630)

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

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Examples found in repository

src/client.rs (line 2635)

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

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Examples found in repository

src/client.rs (line 2641)

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

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Examples found in repository

src/client.rs (line 2650)

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

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Examples found in repository

src/client.rs (line 2656)

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

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

Examples found in repository

src/client.rs (line 2662)

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

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

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

Examples found in repository

src/client.rs (line 2667)

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

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

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

Examples found in repository

src/client.rs (line 2672)

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

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

Appends an item to parameters.

To override the contents of this collection use set_parameters.

The input parameters for the stack set template.

Examples found in repository

src/client.rs (line 2681)

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

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

The input parameters for the stack set template.

Examples found in repository

src/client.rs (line 2689)

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

pub fn capabilities(self, input: Capability) -> Self

Appends an item to capabilities.

To override the contents of this collection use set_capabilities.

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

• CAPABILITY_IAM and CAPABILITY_NAMED_IAM

  Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

  • If you have IAM resources, you can specify either capability.

  • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

  • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

  • AWS::IAM::AccessKey

  • AWS::IAM::Group

  • AWS::IAM::InstanceProfile

  • AWS::IAM::Policy

  • AWS::IAM::Role

  • AWS::IAM::User

  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• CAPABILITY_AUTO_EXPAND

  Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

  Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Examples found in repository

src/client.rs (line 2718)

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

pub fn set_capabilities(self, input: Option<Vec<Capability>>) -> Self

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

• CAPABILITY_IAM and CAPABILITY_NAMED_IAM

  Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

  • If you have IAM resources, you can specify either capability.

  • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

  • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

  • AWS::IAM::AccessKey

  • AWS::IAM::Group

  • AWS::IAM::InstanceProfile

  • AWS::IAM::Policy

  • AWS::IAM::Role

  • AWS::IAM::User

  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM Resources in CloudFormation Templates.

• CAPABILITY_AUTO_EXPAND

  Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

  Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Examples found in repository

src/client.rs (line 2746)

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

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Examples found in repository

src/client.rs (line 2756)

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Examples found in repository

src/client.rs (line 2765)

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

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

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

Examples found in repository

src/client.rs (line 2771)

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

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

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

Examples found in repository

src/client.rs (line 2780)

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

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

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

Examples found in repository

src/client.rs (line 2786)

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

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

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

Examples found in repository

src/client.rs (line 2795)

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

pub fn permission_model(self, input: PermissionModels) -> Self

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

Examples found in repository

src/client.rs (line 2804)

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

pub fn set_permission_model(self, input: Option<PermissionModels>) -> Self

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

• With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.

• With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

Examples found in repository

src/client.rs (line 2816)

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

pub fn auto_deployment(self, input: AutoDeployment) -> Self

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Examples found in repository

src/client.rs (line 2821)

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

pub fn set_auto_deployment(self, input: Option<AutoDeployment>) -> Self

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Examples found in repository

src/client.rs (line 2829)

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

• To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

• To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Examples found in repository

src/client.rs (line 2840)

        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.

• To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

• To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Examples found in repository

src/client.rs (line 2851)

        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 client_request_token(self, input: impl Into<String>) -> Self

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Examples found in repository

src/client.rs (line 2857)

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

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

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Examples found in repository

src/client.rs (line 2866)

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

pub fn managed_execution(self, input: ManagedExecution) -> Self

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Examples found in repository

src/client.rs (line 2871)

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

pub fn set_managed_execution(self, input: Option<ManagedExecution>) -> Self

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

Examples found in repository

src/client.rs (line 2879)

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

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

Consumes the builder and constructs a CreateStackSetInput.

Examples found in repository

src/client.rs (line 2580)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateStackSet,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateStackSetError>,
        > {
            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::CreateStackSetOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateStackSetError>,
        > {
            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