Class StackSetSummary
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.StackSetSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackSetSummary.Builder,StackSetSummary>
@Generated("software.amazon.awssdk:codegen") public final class StackSetSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StackSetSummary.Builder,StackSetSummary>
The structures that contain summary information about the specified stack set.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StackSetSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AutoDeployment
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()
String
description()
A description of the stack set that you specify when the stack set is created or updated.StackDriftStatus
driftStatus()
Status of the stack set's actual configuration compared to its expected template and parameter configuration.String
driftStatusAsString()
Status of the stack set's actual configuration compared to its expected template and parameter configuration.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Instant
lastDriftCheckTimestamp()
Most recent time when CloudFormation performed a drift detection operation on the stack set.ManagedExecution
managedExecution()
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.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.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends StackSetSummary.Builder>
serializableBuilderClass()
String
stackSetId()
The ID of the stack set.String
stackSetName()
The name of the stack set.StackSetStatus
status()
The status of the stack set.String
statusAsString()
The status of the stack set.StackSetSummary.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 of the stack set.
- Returns:
- The name of 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 returnStackSetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 returnStackSetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the stack set.
- See Also:
StackSetStatus
-
autoDeployment
public final AutoDeployment 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
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 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:
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 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:
PermissionModels
-
-
driftStatus
public final StackDriftStatus 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:
StackDriftStatus
-
-
driftStatusAsString
public final String 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:
StackDriftStatus
-
-
lastDriftCheckTimestamp
public final Instant 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
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 StackSetSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StackSetSummary.Builder,StackSetSummary>
-
builder
public static StackSetSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends StackSetSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-