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:

  • Method Details

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

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

    • accountsUrl

      public final String accountsUrl()

      Returns the value of the AccountsUrl property.

      Returns:
      Returns the value of the AccountsUrl property.

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

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

    • 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:

    • 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:

    • toBuilder

      public DeploymentTargets.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeploymentTargets.Builder,DeploymentTargets>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.