StackSet (AWS Java SDK :: Services :: AWS CloudFormation 2.10.75 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 AWS 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 AWS 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()` Returns true if the Capabilities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasOrganizationalUnitIds()` Returns true if the OrganizationalUnitIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasParameters()` Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`organizationalUnitIds()` [`Service-managed` permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.
`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 String stackSetName()
```
    The name that's associated with the stack set.
    
    Returns:
    
    The name that's associated with the stack set.
  - stackSetId
```
public String stackSetId()
```
    The ID of the stack set.
    
    Returns:
    
    The ID of the stack set.
  - description
```
public 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 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 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 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 boolean hasParameters()
```
    Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - parameters
```
public 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.
    
    You can use hasParameters() to see if a value was sent in this field.
    
    Returns:
    
    A list of input parameters for a stack set.
  - capabilities
```
public 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 AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCapabilities() to see if a value was sent in this field.
    
    Returns:
    
    The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
  - hasCapabilities
```
public boolean hasCapabilities()
```
    Returns true if the Capabilities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - capabilitiesAsStrings
```
public 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 AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCapabilities() to see if a value was sent in this field.
    
    Returns:
    
    The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
  - stackSetARN
```
public String stackSetARN()
```
    The Amazon Resource Number (ARN) of the stack set.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the stack set.
  - administrationRoleARN
```
public 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 AWS 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 AWS CloudFormation User Guide.
  - executionRoleName
```
public 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 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 AutoDeployment autoDeployment()
```
    [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
    
    Returns:
    
    [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
  - permissionModel
```
public 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 AWS 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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    See Also:
    
    PermissionModels
  - permissionModelAsString
```
public 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 AWS 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 AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
    See Also:
    
    PermissionModels
  - hasOrganizationalUnitIds
```
public boolean hasOrganizationalUnitIds()
```
    Returns true if the OrganizationalUnitIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - organizationalUnitIds
```
public List<String> organizationalUnitIds()
```
    [Service-managed permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOrganizationalUnitIds() to see if a value was sent in this field.
    
    Returns:
    
    [Service-managed permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields