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

Class StackSet

java.lang.Object
software.amazon.awssdk.services.cloudformation.model.StackSet
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StackSet.Builder,StackSet>
@Generated("software.amazon.awssdk:codegen") public final class StackSet extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StackSet.Builder,StackSet>

A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

See Also:

  • Method Details

    • stackSetName

      public final String stackSetName()

      The name that's associated with the stack set.

      Returns:
      The name that's associated with the stack set.

    • stackSetId

      public final String stackSetId()

      The ID of the stack set.

      Returns:
      The ID of the stack set.

    • description

      public final String description()

      A description of the stack set that you specify when the stack set is created or updated.

      Returns:
      A description of the stack set that you specify when the stack set is created or updated.

    • status

      public final StackSetStatus status()

      The status of the stack set.

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

      Returns:
      The status of the stack set.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the stack set.

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

      Returns:
      The status of the stack set.
      See Also:

    • templateBody

      public final String templateBody()

      The structure that contains the body of the template that was used to create or update the stack set.

      Returns:
      The structure that contains the body of the template that was used to create or update the stack set.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters 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.

    • parameters

      public final List<Parameter> parameters()

      A list of input parameters for a stack set.

      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 hasParameters() method.

      Returns:
      A list of input parameters for a stack set.

    • capabilities

      public final List<Capability> capabilities()

      The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

      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 hasCapabilities() method.

      Returns:
      The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

    • hasCapabilities

      public final boolean hasCapabilities()
      For responses, this returns true if the service returned a value for the Capabilities 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.

    • capabilitiesAsStrings

      public final List<String> capabilitiesAsStrings()

      The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

      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 hasCapabilities() method.

      Returns:
      The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

      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 hasTags() method.

      Returns:
      A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

    • stackSetARN

      public final String stackSetARN()

      The Amazon Resource Name (ARN) of the stack set.

      Returns:
      The Amazon Resource Name (ARN) of the stack set.

    • administrationRoleARN

      public final String administrationRoleARN()

      The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

      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 CloudFormation User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.

      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 CloudFormation User Guide.

    • executionRoleName

      public final String executionRoleName()

      The name of the IAM execution role used to create or update the stack set.

      Use customized execution roles to control which stack resources users and groups can include in their stack sets.

      Returns:
      The name of the IAM execution role used to create or update the stack set.

      Use customized execution roles to control which stack resources users and groups can include in their stack sets.

    • stackSetDriftDetectionDetails

      public final StackSetDriftDetectionDetails stackSetDriftDetectionDetails()

      Detailed information about the drift status of the stack set.

      For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

      Returns:
      Detailed information about the drift status of the stack set.

      For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress isn't included.

    • autoDeployment

      public final AutoDeployment autoDeployment()

      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

      Returns:
      [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

    • permissionModel

      public final PermissionModels permissionModel()

      Describes how the IAM roles required for stack set operations are created.

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

      Returns:
      Describes how the IAM roles required for stack set operations are created.

      See Also:

    • permissionModelAsString

      public final String permissionModelAsString()

      Describes how the IAM roles required for stack set operations are created.

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

      Returns:
      Describes how the IAM roles required for stack set operations are created.

      See Also:

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

      [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

      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:
      [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

    • managedExecution

      public final ManagedExecution managedExecution()

      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

      Returns:
      Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions 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.

    • regions

      public final List<String> regions()

      Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

      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 hasRegions() method.

      Returns:
      Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.

    • toBuilder

      public StackSet.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<StackSet.Builder,StackSet>
      Returns:
      a builder for type T

    • builder

      public static StackSet.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StackSet.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.