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 OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

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()	Limit deployment targets to individual accounts or include additional accounts with provided OUs.
default List<String>	getAccounts()	The names of one or more AWS accounts for which you want to deploy stack set updates.
default String	getAccountsUrl()	Returns the value of the AccountsUrl property.
default List<String>	getOrganizationalUnitIds()	The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountFilterType

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

Limit deployment targets to individual accounts or include additional accounts with provided OUs.

The following is a list of possible values for the AccountFilterType operation.

• INTERSECTION : StackSets deploys to the accounts specified in Accounts parameter.
• DIFFERENCE : StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
• UNION : StackSets includes additional accounts deployment targets.

This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.

• NONE : Deploys to all the accounts in specified organizational units (OU).

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 names of one or more AWS accounts for which you want to deploy stack set updates.

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()

Returns the value of the AccountsUrl property.

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 to which StackSets deploys.

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