StackSet (AWS Java SDK :: Services :: AWS CloudFormation 2.17.109 API)

java.lang.Object
- software.amazon.awssdk.services.cloudformation.model.StackSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackSet.Builder,StackSet>
```
@Generated(value="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, as well as any parameters and capabilities that the template requires.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StackSet.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StackSet.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`administrationRoleARN()` The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
`AutoDeployment`	`autoDeployment()` [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).
`static StackSet.Builder`	`builder()`
`List<Capability>`	`capabilities()` The capabilities that are allowed in the stack set.
`List<String>`	`capabilitiesAsStrings()` The capabilities that are allowed in the stack set.
`String`	`description()` A description of the stack set that you specify when the stack set is created or updated.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleName()` The name of the IAM execution role used to create or update the stack set.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCapabilities()` For responses, this returns true if the service returned a value for the Capabilities property.
`int`	`hashCode()`
`boolean`	`hasOrganizationalUnitIds()` For responses, this returns true if the service returned a value for the OrganizationalUnitIds property.
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`ManagedExecution`	`managedExecution()` Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
`List<String>`	`organizationalUnitIds()` [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
`List<Parameter>`	`parameters()` A list of input parameters for a stack set.
`PermissionModels`	`permissionModel()` Describes how the IAM roles required for stack set operations are created.
`String`	`permissionModelAsString()` Describes how the IAM roles required for stack set operations are created.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StackSet.Builder>`	`serializableBuilderClass()`
`String`	`stackSetARN()` The Amazon Resource Number (ARN) of the stack set.
`StackSetDriftDetectionDetails`	`stackSetDriftDetectionDetails()` Detailed information about the drift status of the stack set.
`String`	`stackSetId()` The ID of the stack set.
`String`	`stackSetName()` The name that's associated with the stack set.
`StackSetStatus`	`status()` The status of the stack set.
`String`	`statusAsString()` The status of the stack set.
`List<Tag>`	`tags()` A list of tags that specify information about the stack set.
`String`	`templateBody()` The structure that contains the body of the template that was used to create or update the stack set.
`StackSet.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
  - 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:
    
    StackSetStatus
  - 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:
    
    StackSetStatus
  - 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 Number (ARN) of the stack set.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the stack set.
  - administrationRoleARN
```
public final String administrationRoleARN()
```
    The Amazon Resource Number (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 Number (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 is not 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 is not 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.
    - With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
    - With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    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.
    
    With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
    
    With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    See Also:
    
    PermissionModels
  - permissionModelAsString
```
public final String permissionModelAsString()
```
    Describes how the IAM roles required for stack set operations are created.
    - With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
    - With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    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.
    
    With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.
    
    With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    See Also:
    
    PermissionModels
  - 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.
  - toBuilder
```
public StackSet.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StackSet.Builder,StackSet>
  - 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)
```
    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

Class StackSet

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

stackSetName

stackSetId

description

status

statusAsString

templateBody

hasParameters

parameters

capabilities

hasCapabilities

capabilitiesAsStrings

hasTags

tags

stackSetARN

administrationRoleARN

executionRoleName

stackSetDriftDetectionDetails

autoDeployment

permissionModel

permissionModelAsString

hasOrganizationalUnitIds

organizationalUnitIds

managedExecution

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields