Class CfnStackSet.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStackSet>
- Enclosing class:
- CfnStackSet
CfnStackSet
.-
Method Summary
Modifier and TypeMethodDescriptionadministrationRoleArn
(String administrationRoleArn) The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.autoDeployment
(IResolvable autoDeployment) [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).autoDeployment
(CfnStackSet.AutoDeploymentProperty autoDeployment) [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).build()
[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
(List<String> capabilities) The capabilities that are allowed in the stack set.static CfnStackSet.Builder
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.managedExecution
(Object managedExecution) Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.operationPreferences
(IResolvable operationPreferences) The user-specified preferences for how AWS CloudFormation performs a stack set operation.operationPreferences
(CfnStackSet.OperationPreferencesProperty operationPreferences) The user-specified preferences for how AWS CloudFormation performs a stack set operation.parameters
(List<? extends Object> parameters) The input parameters for the stack set template.parameters
(IResolvable parameters) The input parameters for the stack set template.permissionModel
(String permissionModel) Describes how the IAM roles required for stack set operations are created.stackInstancesGroup
(List<? extends Object> stackInstancesGroup) A group of stack instances with parameters in some specific accounts and Regions.stackInstancesGroup
(IResolvable stackInstancesGroup) A group of stack instances with parameters in some specific accounts and Regions.stackSetName
(String stackSetName) The name to associate with the stack set.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) Location of file containing the template body.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnStackSet.Builder
.
-
permissionModel
Describes how the IAM roles required for stack set operations are created.- 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 AWS 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. This parameter is required.- Returns:
this
- With
-
stackSetName
The name to associate with the stack set.The name must be unique in the Region where you create your stack set.
Maximum :
128
Pattern :
^[a-zA-Z][a-zA-Z0-9-]{0,127}$
The
StackSetName
property is required.- Parameters:
stackSetName
- The name to associate with the stack set. This parameter is required.- Returns:
this
-
administrationRoleArn
The Amazon Resource Number (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.
Use 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 AWS CloudFormation User Guide .
Minimum :
20
Maximum :
2048
- Parameters:
administrationRoleArn
- The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. This parameter is required.- Returns:
this
-
autoDeployment
[Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).- Parameters:
autoDeployment
- [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). This parameter is required.- Returns:
this
-
autoDeployment
@Stability(Stable) public CfnStackSet.Builder autoDeployment(CfnStackSet.AutoDeploymentProperty autoDeployment) [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).- Parameters:
autoDeployment
- [Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). This parameter is required.- Returns:
this
-
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 AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
Valid Values :
SELF
|DELEGATED_ADMIN
- 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. This parameter is required.- Returns:
this
- To create a stack set with service-managed permissions while signed in to the management account, specify
-
capabilities
The capabilities that are allowed in the stack set.Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .
- Parameters:
capabilities
- The capabilities that are allowed in the stack set. This parameter is required.- Returns:
this
-
description
A description of the stack set.Minimum :
1
Maximum :
1024
- Parameters:
description
- A description of the stack set. This parameter is required.- Returns:
this
-
executionRoleName
The name of the IAM execution role to use to create the stack set.If you don't specify an execution role, AWS CloudFormation uses the
AWSCloudFormationStackSetExecutionRole
role for the stack set operation.Minimum :
1
Maximum :
64
Pattern :
[a-zA-Z_0-9+=,.@-]+
- Parameters:
executionRoleName
- The name of the IAM execution role to use to create the stack set. This parameter is required.- Returns:
this
-
managedExecution
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.
You can't modify your stack set's execution configuration while there are running or queued operations for that stack set.
When inactive (default), StackSets performs one operation at a time in request order.
- Parameters:
managedExecution
- Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. This parameter is required.- Returns:
this
-
operationPreferences
@Stability(Stable) public CfnStackSet.Builder operationPreferences(IResolvable operationPreferences) The user-specified preferences for how AWS CloudFormation performs a stack set operation.- Parameters:
operationPreferences
- The user-specified preferences for how AWS CloudFormation performs a stack set operation. This parameter is required.- Returns:
this
-
operationPreferences
@Stability(Stable) public CfnStackSet.Builder operationPreferences(CfnStackSet.OperationPreferencesProperty operationPreferences) The user-specified preferences for how AWS CloudFormation performs a stack set operation.- Parameters:
operationPreferences
- The user-specified preferences for how AWS CloudFormation performs a stack set operation. This parameter is required.- Returns:
this
-
parameters
The input parameters for the stack set template.- Parameters:
parameters
- The input parameters for the stack set template. This parameter is required.- Returns:
this
-
parameters
The input parameters for the stack set template.- Parameters:
parameters
- The input parameters for the stack set template. This parameter is required.- Returns:
this
-
stackInstancesGroup
A group of stack instances with parameters in some specific accounts and Regions.- Parameters:
stackInstancesGroup
- A group of stack instances with parameters in some specific accounts and Regions. This parameter is required.- Returns:
this
-
stackInstancesGroup
@Stability(Stable) public CfnStackSet.Builder stackInstancesGroup(List<? extends Object> stackInstancesGroup) A group of stack instances with parameters in some specific accounts and Regions.- Parameters:
stackInstancesGroup
- A group of stack instances with parameters in some specific accounts and Regions. This parameter is required.- Returns:
this
-
tags
The key-value pairs to associate with this stack set and the stacks created from it.AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
- Parameters:
tags
- The key-value pairs to associate with this stack set and the stacks created from it. This parameter is required.- Returns:
this
-
templateBody
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.You must include either
TemplateURL
orTemplateBody
in a StackSet, but you can't use both. Dynamic references in theTemplateBody
may not work correctly in all cases. It's recommended to pass templates containing dynamic references throughTemplateUrl
instead.Minimum :
1
Maximum :
51200
- Parameters:
templateBody
- The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. This parameter is required.- Returns:
this
-
templateUrl
Location of file containing the template body.The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket.
You must include either
TemplateURL
orTemplateBody
in a StackSet, but you can't use both.Minimum :
1
Maximum :
1024
- Parameters:
templateUrl
- Location of file containing the template body. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnStackSet>
- Returns:
- a newly built instance of
CfnStackSet
.
-