Class StackSetSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackSetSummary.Builder,
StackSetSummary>
The structures that contain summary information about the specified stack set.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AutoDeployment
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).static StackSetSummary.Builder
builder()
final String
A description of the stack set that you specify when the stack set is created or updated.final StackDriftStatus
Status of the stack set's actual configuration compared to its expected template and parameter configuration.final String
Status of the stack set's actual configuration compared to its expected template and parameter configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
Most recent time when CloudFormation performed a drift detection operation on the stack set.final ManagedExecution
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.final PermissionModels
Describes how the IAM roles required for stack set operations are created.final String
Describes how the IAM roles required for stack set operations are created.static Class
<? extends StackSetSummary.Builder> final String
The ID of the stack set.final String
The name of the stack set.final StackSetStatus
status()
The status of the stack set.final String
The status of the stack set.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stackSetName
The name of the stack set.
- Returns:
- The name of the stack set.
-
stackSetId
The ID of the stack set.
- Returns:
- The ID of the stack set.
-
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
The status of the stack set.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStackSetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the stack set.
- See Also:
-
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 returnStackSetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the stack set.
- See Also:
-
autoDeployment
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
- Returns:
- [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).
-
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 returnPermissionModels.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionModelAsString()
.- 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:
-
-
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 returnPermissionModels.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionModelAsString()
.- 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:
-
-
driftStatus
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.
-
DRIFTED
: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. -
NOT_CHECKED
: CloudFormation hasn't checked the stack set for drift. -
IN_SYNC
: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration. -
UNKNOWN
: This value is reserved for future use.
If the service returns an enum value that is not available in the current SDK version,
driftStatus
will returnStackDriftStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdriftStatusAsString()
.- Returns:
- Status of the stack set's actual configuration compared to its expected template and parameter
configuration. A stack set is considered to have drifted if one or more of its stack instances have
drifted from their expected template and parameter configuration.
-
DRIFTED
: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. -
NOT_CHECKED
: CloudFormation hasn't checked the stack set for drift. -
IN_SYNC
: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration. -
UNKNOWN
: This value is reserved for future use.
-
- See Also:
-
-
driftStatusAsString
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.
-
DRIFTED
: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. -
NOT_CHECKED
: CloudFormation hasn't checked the stack set for drift. -
IN_SYNC
: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration. -
UNKNOWN
: This value is reserved for future use.
If the service returns an enum value that is not available in the current SDK version,
driftStatus
will returnStackDriftStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdriftStatusAsString()
.- Returns:
- Status of the stack set's actual configuration compared to its expected template and parameter
configuration. A stack set is considered to have drifted if one or more of its stack instances have
drifted from their expected template and parameter configuration.
-
DRIFTED
: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. -
NOT_CHECKED
: CloudFormation hasn't checked the stack set for drift. -
IN_SYNC
: All the stack instances belonging to the stack set stack match from the expected template and parameter configuration. -
UNKNOWN
: This value is reserved for future use.
-
- See Also:
-
-
lastDriftCheckTimestamp
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be
NULL
for any stack set on which drift detection hasn't yet been performed.- Returns:
- Most recent time when CloudFormation performed a drift detection operation on the stack set. This value
will be
NULL
for any stack set on which drift detection hasn't yet been performed.
-
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
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 interfaceToCopyableBuilder<StackSetSummary.Builder,
StackSetSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-