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 StackSet.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStackSetSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AutoDeploymentautoDeployment()[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).static StackSetSummary.Builderbuilder()Stringdescription()A description of the StackSet that you specify when the StackSet is created or updated.StackDriftStatusdriftStatus()Status of the StackSet's actual configuration compared to its expected template and parameter configuration.StringdriftStatusAsString()Status of the StackSet's actual configuration compared to its expected template and parameter configuration.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastDriftCheckTimestamp()Most recent time when CloudFormation performed a drift detection operation on the StackSet.ManagedExecutionmanagedExecution()Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.PermissionModelspermissionModel()Describes how the IAM roles required for StackSet operations are created.StringpermissionModelAsString()Describes how the IAM roles required for StackSet operations are created.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends StackSetSummary.Builder>serializableBuilderClass()StringstackSetId()The ID of the StackSet.StringstackSetName()The name of the StackSet.StackSetStatusstatus()The status of the StackSet.StringstatusAsString()The status of the StackSet.StackSetSummary.BuildertoBuilder()StringtoString()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 StackSet.
- Returns:
- The name of the StackSet.
-
stackSetId
public final String stackSetId()
The ID of the StackSet.
- Returns:
- The ID of the StackSet.
-
description
public final String description()
A description of the StackSet that you specify when the StackSet is created or updated.
- Returns:
- A description of the StackSet that you specify when the StackSet is created or updated.
-
status
public final StackSetStatus status()
The status of the StackSet.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStackSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the StackSet.
- See Also:
StackSetStatus
-
statusAsString
public final String statusAsString()
The status of the StackSet.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStackSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the StackSet.
- 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 StackSet operations are created.
-
With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions. -
With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
If the service returns an enum value that is not available in the current SDK version,
permissionModelwill returnPermissionModels.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionModelAsString().- Returns:
- Describes how the IAM roles required for StackSet operations are created.
-
With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions. -
With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
-
- See Also:
PermissionModels
-
-
permissionModelAsString
public final String permissionModelAsString()
Describes how the IAM roles required for StackSet operations are created.
-
With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions. -
With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
If the service returns an enum value that is not available in the current SDK version,
permissionModelwill returnPermissionModels.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionModelAsString().- Returns:
- Describes how the IAM roles required for StackSet operations are created.
-
With
self-managedpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions. -
With
service-managedpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for StackSets with Organizations.
-
- See Also:
PermissionModels
-
-
driftStatus
public final StackDriftStatus driftStatus()
Status of the StackSet's actual configuration compared to its expected template and parameter configuration.
-
DRIFTED: One or more of the stack instances belonging to the StackSet 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 StackSet for drift. -
IN_SYNC: All the stack instances belonging to the StackSet match 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,
driftStatuswill returnStackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdriftStatusAsString().- Returns:
- Status of the StackSet's actual configuration compared to its expected template and parameter
configuration.
-
DRIFTED: One or more of the stack instances belonging to the StackSet 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 StackSet for drift. -
IN_SYNC: All the stack instances belonging to the StackSet match 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 StackSet's actual configuration compared to its expected template and parameter configuration.
-
DRIFTED: One or more of the stack instances belonging to the StackSet 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 StackSet for drift. -
IN_SYNC: All the stack instances belonging to the StackSet match 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,
driftStatuswill returnStackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdriftStatusAsString().- Returns:
- Status of the StackSet's actual configuration compared to its expected template and parameter
configuration.
-
DRIFTED: One or more of the stack instances belonging to the StackSet 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 StackSet for drift. -
IN_SYNC: All the stack instances belonging to the StackSet match 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 StackSet. This value will be
NULLfor any StackSet that drift detection hasn't yet been performed on.- Returns:
- Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value
will be
NULLfor any StackSet that drift detection hasn't yet been performed on.
-
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:
toBuilderin 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:
equalsBySdkFieldsin 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:
sdkFieldNameToFieldin interfaceSdkPojo
-
-