Package software.amazon.awssdk.services.cloudformation.model

Class DeploymentTargets

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.DeploymentTargets

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeploymentTargets.Builder,DeploymentTargets>

@Generated("software.amazon.awssdk:codegen")
public final class DeploymentTargets
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentTargets.Builder,DeploymentTargets>

[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.

For update operations, you can specify either Accounts or OrganizationalUnitIds. For create and delete operations, specify OrganizationalUnitIds.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeploymentTargets.Builder

Method Summary

Modifier and Type	Method	Description
AccountFilterType	accountFilterType()	Limit deployment targets to individual accounts or include additional accounts with provided OUs.
String	accountFilterTypeAsString()	Limit deployment targets to individual accounts or include additional accounts with provided OUs.
List<String>	accounts()	The account IDs of the Amazon Web Services accounts.
String	accountsUrl()	The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs.
static DeploymentTargets.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccounts()	For responses, this returns true if the service returned a value for the Accounts property.
int	hashCode()
boolean	hasOrganizationalUnitIds()	For responses, this returns true if the service returned a value for the OrganizationalUnitIds property.
List<String>	organizationalUnitIds()	The organization root ID or organizational unit (OU) IDs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeploymentTargets.Builder>	serializableBuilderClass()
DeploymentTargets.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasAccounts

public final boolean hasAccounts()

For responses, this returns true if the service returned a value for the Accounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

accounts

public final List<String> accounts()

The account IDs of the Amazon Web Services accounts. If you have many account numbers, you can provide those accounts using the AccountsUrl property instead.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccounts() method.

Returns:

The account IDs of the Amazon Web Services accounts. If you have many account numbers, you can provide those accounts using the AccountsUrl property instead.

accountsUrl

public final String accountsUrl()

The Amazon S3 URL path to a file that contains a list of Amazon Web Services 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).

Returns:

The Amazon S3 URL path to a file that contains a list of Amazon Web Services 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).

hasOrganizationalUnitIds

public final boolean hasOrganizationalUnitIds()

For responses, this returns true if the service returned a value for the OrganizationalUnitIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

organizationalUnitIds

public final List<String> organizationalUnitIds()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationalUnitIds() method.

Returns:

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

accountFilterType

public final AccountFilterType accountFilterType()

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

If the service returns an enum value that is not available in the current SDK version, accountFilterType will return AccountFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountFilterTypeAsString().

Returns:

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:

AccountFilterType

accountFilterTypeAsString

public final String accountFilterTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, accountFilterType will return AccountFilterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountFilterTypeAsString().

Returns:

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:

AccountFilterType

toBuilder

public DeploymentTargets.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeploymentTargets.Builder,DeploymentTargets>

builder

public static DeploymentTargets.Builder builder()

serializableBuilderClass

public static Class<? extends DeploymentTargets.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo