Package software.amazon.awscdk

Class CfnStackSet.Builder

java.lang.Object

software.amazon.awscdk.CfnStackSet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStackSet>

Enclosing class:

CfnStackSet

@Stability(Stable)
public static final class CfnStackSet.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStackSet>

A fluent builder for CfnStackSet.

Method Summary

Modifier and Type	Method	Description
CfnStackSet.Builder	administrationRoleArn(String administrationRoleArn)	The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
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).
CfnStackSet.Builder	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).
CfnStackSet	build()
CfnStackSet.Builder	callAs(String 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.
CfnStackSet.Builder	capabilities(List<String> capabilities)	The capabilities that are allowed in the stack set.
static CfnStackSet.Builder	create(software.constructs.Construct scope, String id)
CfnStackSet.Builder	description(String description)	A description of the stack set.
CfnStackSet.Builder	executionRoleName(String executionRoleName)	The name of the IAM execution role to use to create the stack set.
CfnStackSet.Builder	managedExecution(Object managedExecution)	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
CfnStackSet.Builder	operationPreferences(CfnStackSet.OperationPreferencesProperty operationPreferences)	The user-specified preferences for how AWS CloudFormation performs a stack set operation.
CfnStackSet.Builder	operationPreferences(IResolvable operationPreferences)	The user-specified preferences for how AWS CloudFormation performs a stack set operation.
CfnStackSet.Builder	parameters(List<? extends Object> parameters)	The input parameters for the stack set template.
CfnStackSet.Builder	parameters(IResolvable parameters)	The input parameters for the stack set template.
CfnStackSet.Builder	permissionModel(String permissionModel)	Describes how the IAM roles required for stack set operations are created.
CfnStackSet.Builder	stackInstancesGroup(List<? extends Object> stackInstancesGroup)	A group of stack instances with parameters in some specific accounts and Regions.
CfnStackSet.Builder	stackInstancesGroup(IResolvable stackInstancesGroup)	A group of stack instances with parameters in some specific accounts and Regions.
CfnStackSet.Builder	stackSetName(String stackSetName)	The name to associate with the stack set.
CfnStackSet.Builder	tags(List<? extends CfnTag> tags)	Key-value pairs to associate with this stack.
CfnStackSet.Builder	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.
CfnStackSet.Builder	templateUrl(String templateUrl)	Location of file containing the template body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnStackSet.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnStackSet.Builder.

permissionModel

@Stability(Stable)
public CfnStackSet.Builder permissionModel(String 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 .

Parameters:

permissionModel - Describes how the IAM roles required for stack set operations are created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel

stackSetName

@Stability(Stable)
public CfnStackSet.Builder stackSetName(String stackSetName)

The name to associate with the stack set.

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

The StackSetName property is required.

Parameters:

stackSetName - The name to associate with the stack set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname

administrationRoleArn

@Stability(Stable)
public CfnStackSet.Builder administrationRoleArn(String 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn

autoDeployment

@Stability(Stable)
public CfnStackSet.Builder 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).

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment

callAs

@Stability(Stable)
public CfnStackSet.Builder callAs(String 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 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas

capabilities

@Stability(Stable)
public CfnStackSet.Builder capabilities(List<String> 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities

description

@Stability(Stable)
public CfnStackSet.Builder description(String 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description

executionRoleName

@Stability(Stable)
public CfnStackSet.Builder executionRoleName(String 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename

managedExecution

@Stability(Stable)
public CfnStackSet.Builder managedExecution(Object 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences

parameters

@Stability(Stable)
public CfnStackSet.Builder parameters(IResolvable 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters

parameters

@Stability(Stable)
public CfnStackSet.Builder parameters(List<? extends Object> 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters

stackInstancesGroup

@Stability(Stable)
public CfnStackSet.Builder stackInstancesGroup(IResolvable 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup

tags

@Stability(Stable)
public CfnStackSet.Builder tags(List<? extends CfnTag> tags)

Key-value pairs to associate with this stack.

CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Parameters:

tags - Key-value pairs to associate with this stack. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags

templateBody

@Stability(Stable)
public CfnStackSet.Builder 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.

You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both. Dynamic references in the TemplateBody may not work correctly in all cases. It's recommended to pass templates containing dynamic references through TemplateUrl instead.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody

templateUrl

@Stability(Stable)
public CfnStackSet.Builder templateUrl(String templateUrl)

Location of file containing the template body.

The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL .

Parameters:

templateUrl - Location of file containing the template body. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl

build

@Stability(Stable)
public CfnStackSet build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnStackSet>

Returns:

a newly built instance of CfnStackSet.