Struct aws_sdk_cloudformation::operation::create_stack_set::builders::CreateStackSetFluentBuilder
source · pub struct CreateStackSetFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateStackSet
.
Creates a stack set.
Implementations§
source§impl CreateStackSetFluentBuilder
impl CreateStackSetFluentBuilder
sourcepub fn as_input(&self) -> &CreateStackSetInputBuilder
pub fn as_input(&self) -> &CreateStackSetInputBuilder
Access the CreateStackSet as a reference.
sourcepub async fn send(
self
) -> Result<CreateStackSetOutput, SdkError<CreateStackSetError, HttpResponse>>
pub async fn send( self ) -> Result<CreateStackSetOutput, SdkError<CreateStackSetError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateStackSetOutput, CreateStackSetError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateStackSetOutput, CreateStackSetError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stack_set_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_stack_set_name(self, input: Option<String>) -> 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.
sourcepub fn get_stack_set_name(&self) -> &Option<String>
pub fn get_stack_set_name(&self) -> &Option<String>
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.
sourcepub fn description(self, input: impl Into<String>) -> 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.
sourcepub fn set_description(self, input: Option<String>) -> 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.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
sourcepub fn template_body(self, input: impl Into<String>) -> 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.
sourcepub fn set_template_body(self, input: Option<String>) -> 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.
sourcepub fn get_template_body(&self) -> &Option<String>
pub fn get_template_body(&self) -> &Option<String>
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.
sourcepub fn template_url(self, input: impl Into<String>) -> 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.
sourcepub fn set_template_url(self, input: Option<String>) -> 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.
sourcepub fn get_template_url(&self) -> &Option<String>
pub fn get_template_url(&self) -> &Option<String>
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.
sourcepub fn stack_id(self, input: impl Into<String>) -> 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.
sourcepub fn set_stack_id(self, input: Option<String>) -> 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.
sourcepub fn get_stack_id(&self) -> &Option<String>
pub fn get_stack_id(&self) -> &Option<String>
The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.
sourcepub fn parameters(self, input: Parameter) -> 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.
sourcepub fn set_parameters(self, input: Option<Vec<Parameter>>) -> Self
pub fn set_parameters(self, input: Option<Vec<Parameter>>) -> Self
The input parameters for the stack set template.
sourcepub fn get_parameters(&self) -> &Option<Vec<Parameter>>
pub fn get_parameters(&self) -> &Option<Vec<Parameter>>
The input parameters for the stack set template.
sourcepub fn capabilities(self, input: Capability) -> 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
andCAPABILITY_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
orCAPABILITY_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.
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.
sourcepub fn set_capabilities(self, input: Option<Vec<Capability>>) -> 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
andCAPABILITY_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
orCAPABILITY_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.
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.
sourcepub fn get_capabilities(&self) -> &Option<Vec<Capability>>
pub fn get_capabilities(&self) -> &Option<Vec<Capability>>
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
andCAPABILITY_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
orCAPABILITY_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.
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.
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.
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.
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.
sourcepub fn administration_role_arn(self, input: impl Into<String>) -> 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.
sourcepub fn set_administration_role_arn(self, input: Option<String>) -> 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.
sourcepub fn get_administration_role_arn(&self) -> &Option<String>
pub fn get_administration_role_arn(&self) -> &Option<String>
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.
sourcepub fn execution_role_name(self, input: impl Into<String>) -> 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.
sourcepub fn set_execution_role_name(self, input: Option<String>) -> 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.
sourcepub fn get_execution_role_name(&self) -> &Option<String>
pub fn get_execution_role_name(&self) -> &Option<String>
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.
sourcepub fn permission_model(self, input: PermissionModels) -> 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.
sourcepub fn set_permission_model(self, input: Option<PermissionModels>) -> 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.
sourcepub fn get_permission_model(&self) -> &Option<PermissionModels>
pub fn get_permission_model(&self) -> &Option<PermissionModels>
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.
sourcepub fn auto_deployment(self, input: AutoDeployment) -> 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
.
sourcepub fn set_auto_deployment(self, input: Option<AutoDeployment>) -> 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
.
sourcepub fn get_auto_deployment(&self) -> &Option<AutoDeployment>
pub fn get_auto_deployment(&self) -> &Option<AutoDeployment>
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
.
sourcepub fn call_as(self, input: CallAs) -> 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.
sourcepub fn set_call_as(self, input: Option<CallAs>) -> 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.
sourcepub fn get_call_as(&self) -> &Option<CallAs>
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.
-
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.
sourcepub fn client_request_token(self, input: impl Into<String>) -> 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.
sourcepub fn set_client_request_token(self, input: Option<String>) -> 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.
sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
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.
sourcepub fn managed_execution(self, input: ManagedExecution) -> Self
pub fn managed_execution(self, input: ManagedExecution) -> Self
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
sourcepub fn set_managed_execution(self, input: Option<ManagedExecution>) -> Self
pub fn set_managed_execution(self, input: Option<ManagedExecution>) -> Self
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
sourcepub fn get_managed_execution(&self) -> &Option<ManagedExecution>
pub fn get_managed_execution(&self) -> &Option<ManagedExecution>
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Trait Implementations§
source§impl Clone for CreateStackSetFluentBuilder
impl Clone for CreateStackSetFluentBuilder
source§fn clone(&self) -> CreateStackSetFluentBuilder
fn clone(&self) -> CreateStackSetFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateStackSetFluentBuilder
impl !RefUnwindSafe for CreateStackSetFluentBuilder
impl Send for CreateStackSetFluentBuilder
impl Sync for CreateStackSetFluentBuilder
impl Unpin for CreateStackSetFluentBuilder
impl !UnwindSafe for CreateStackSetFluentBuilder
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