Package software.amazon.awscdk.services.cloudformation

Interface CfnStackSet.DeploymentTargetsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStackSet.DeploymentTargetsProperty.Jsii$Proxy

Enclosing class:

CfnStackSet

@Stability(Stable)
public static interface CfnStackSet.DeploymentTargetsProperty
extends software.amazon.jsii.JsiiSerializable

The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.

When deploying to AWS Organizations accounts with SERVICE_MANAGED permissions:

• You must specify the OrganizationalUnitIds property.
• If you specify organizational units (OUs) for OrganizationalUnitIds and use either the Accounts or AccountsUrl property, you must also specify the AccountFilterType property.

When deploying to AWS accounts with SELF_MANAGED permissions:

• You must specify either the Accounts or AccountsUrl property, but not both.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 DeploymentTargetsProperty deploymentTargetsProperty = DeploymentTargetsProperty.builder()
         .accountFilterType("accountFilterType")
         .accounts(List.of("accounts"))
         .accountsUrl("accountsUrl")
         .organizationalUnitIds(List.of("organizationalUnitIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStackSet.DeploymentTargetsProperty.Builder	A builder for CfnStackSet.DeploymentTargetsProperty
static final class	CfnStackSet.DeploymentTargetsProperty.Jsii$Proxy	An implementation for CfnStackSet.DeploymentTargetsProperty

Method Summary

Modifier and Type	Method	Description
static CfnStackSet.DeploymentTargetsProperty.Builder	builder()
default String	getAccountFilterType()	Refines which accounts to deploy stacks to by specifying how to use the Accounts and OrganizationalUnitIds properties together.
default List<String>	getAccounts()	The account IDs of the AWS accounts .
default String	getAccountsUrl()	The Amazon S3 URL path to a file that contains a list of AWS account IDs.
default List<String>	getOrganizationalUnitIds()	The organization root ID or organizational unit (OU) IDs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountFilterType

@Stability(Stable)
@Nullable
default String getAccountFilterType()

Refines which accounts to deploy stacks to by specifying how to use the Accounts and OrganizationalUnitIds properties together.

The following values determine how CloudFormation selects target accounts:

• INTERSECTION : StackSet deploys to the accounts specified in the Accounts property.
• DIFFERENCE : StackSet deploys to the OU, excluding the accounts specified in the Accounts property.
• UNION : StackSet deploys to the OU, and the accounts specified in the Accounts property. UNION is not supported for create operations when using StackSet as a resource or the CreateStackInstances API.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype

getAccounts

@Stability(Stable)
@Nullable
default List<String> getAccounts()

The account IDs of the AWS accounts .

If you have many account numbers, you can provide those accounts using the AccountsUrl property instead.

Pattern : ^[0-9]{12}$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts

getAccountsUrl

@Stability(Stable)
@Nullable
default String getAccountsUrl()

The Amazon S3 URL path to a file that contains a list of AWS account IDs.

The file format must be either .csv or .txt , and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).

This property serves the same purpose as Accounts but allows you to specify a large number of accounts.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountsurl

getOrganizationalUnitIds

@Stability(Stable)
@Nullable
default List<String> getOrganizationalUnitIds()

The organization root ID or organizational unit (OU) IDs.

Pattern : ^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids

builder

@Stability(Stable)
static CfnStackSet.DeploymentTargetsProperty.Builder builder()

Returns:

a CfnStackSet.DeploymentTargetsProperty.Builder of CfnStackSet.DeploymentTargetsProperty