Interface CreateStackSetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<CreateStackSetRequest.Builder,
,CreateStackSetRequest> SdkBuilder<CreateStackSetRequest.Builder,
,CreateStackSetRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateStackSetRequest
-
Method Summary
Modifier and TypeMethodDescriptionadministrationRoleARN
(String administrationRoleARN) The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.default CreateStackSetRequest.Builder
autoDeployment
(Consumer<AutoDeployment.Builder> autoDeployment) Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU).autoDeployment
(AutoDeployment autoDeployment) Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU).[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.[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.capabilities
(Collection<Capability> 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.capabilities
(Capability... 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.capabilitiesWithStrings
(String... 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.capabilitiesWithStrings
(Collection<String> 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.clientRequestToken
(String clientRequestToken) A unique identifier for thisCreateStackSet
request.description
(String description) A description of the stack set.executionRoleName
(String executionRoleName) The name of the IAM execution role to use to create the stack set.default CreateStackSetRequest.Builder
managedExecution
(Consumer<ManagedExecution.Builder> managedExecution) Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.managedExecution
(ManagedExecution managedExecution) Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameters
(Collection<Parameter> parameters) The input parameters for the stack set template.parameters
(Consumer<Parameter.Builder>... parameters) The input parameters for the stack set template.parameters
(Parameter... parameters) The input parameters for the stack set template.permissionModel
(String permissionModel) Describes how the IAM roles required for stack set operations are created.permissionModel
(PermissionModels permissionModel) Describes how the IAM roles required for stack set operations are created.The stack ID you are importing into a new stack set.stackSetName
(String stackSetName) The name to associate with the stack set.tags
(Collection<Tag> tags) The key-value pairs to associate with this stack set and the stacks created from it.tags
(Consumer<Tag.Builder>... tags) The key-value pairs to associate with this stack set and the stacks created from it.The key-value pairs to associate with this stack set and the stacks created from it.templateBody
(String templateBody) The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.templateURL
(String templateURL) The location of the file that contains the template body.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
stackSetName
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.
- Parameters:
stackSetName
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
- Parameters:
description
- A description of the stack set. You can use the description to identify the stack set's purpose or other important information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateBody
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.
- Parameters:
templateBody
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateURL
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.
- Parameters:
templateURL
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stackId
The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.
- Parameters:
stackId
- The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The input parameters for the stack set template.
- Parameters:
parameters
- The input parameters for the stack set template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The input parameters for the stack set template.
- Parameters:
parameters
- The input parameters for the stack set template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The input parameters for the stack set template.
This is a convenience method that creates an instance of theParameter.Builder
avoiding the need to create one manually viaParameter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(List<Parameter>)
.- Parameters:
parameters
- a consumer that will call methods onParameter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
capabilitiesWithStrings
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
capabilitiesWithStrings
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 entireCreateStackSet
action fails with anaccess denied
error, and the stack set is not created.- Parameters:
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 entireCreateStackSet
action fails with anaccess denied
error, and the stack set is not created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 entireCreateStackSet
action fails with anaccess denied
error, and the stack set is not created.- Parameters:
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 entireCreateStackSet
action fails with anaccess denied
error, and the stack set is not created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theCreateStackSet
action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entireCreateStackSet
action fails with anaccess denied
error, and the stack set is not created.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
administrationRoleARN
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.
- Parameters:
administrationRoleARN
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionRoleName
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.
- Parameters:
executionRoleName
- The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses theAWSCloudFormationStackSetExecutionRole
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
permissionModel
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.
- Parameters:
permissionModel
- 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
permissionModel
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.
- Parameters:
permissionModel
- 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
autoDeployment
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if
PermissionModel
isSERVICE_MANAGED
.- Parameters:
autoDeployment
- Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only ifPermissionModel
isSERVICE_MANAGED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoDeployment
default CreateStackSetRequest.Builder autoDeployment(Consumer<AutoDeployment.Builder> autoDeployment) Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if
This is a convenience method that creates an instance of thePermissionModel
isSERVICE_MANAGED
.AutoDeployment.Builder
avoiding the need to create one manually viaAutoDeployment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoDeployment(AutoDeployment)
.- Parameters:
autoDeployment
- a consumer that will call methods onAutoDeployment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. UseSELF
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.
- Parameters:
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. UseSELF
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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. UseSELF
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.
- Parameters:
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. UseSELF
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
clientRequestToken
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 retryCreateStackSet
requests to ensure that CloudFormation successfully received them.If you don't specify an operation ID, the SDK generates one automatically.
- Parameters:
clientRequestToken
- A unique identifier for thisCreateStackSet
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 retryCreateStackSet
requests to ensure that CloudFormation successfully received them.If you don't specify an operation ID, the SDK generates one automatically.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
managedExecution
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
- Parameters:
managedExecution
- Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
managedExecution
default CreateStackSetRequest.Builder managedExecution(Consumer<ManagedExecution.Builder> managedExecution) Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
This is a convenience method that creates an instance of theManagedExecution.Builder
avoiding the need to create one manually viaManagedExecution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanagedExecution(ManagedExecution)
.- Parameters:
managedExecution
- a consumer that will call methods onManagedExecution.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateStackSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateStackSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-