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

Modifier and Type	Method	Description
final 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()
final String	description()	A description of the stack set that you specify when the stack set is created or updated.
final StackDriftStatus	driftStatus()	Status of the stack set's actual configuration compared to its expected template and parameter configuration.
final String	driftStatusAsString()	Status of the stack set's actual configuration compared to its expected template and parameter configuration.
final boolean	equals(Object obj)
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	lastDriftCheckTimestamp()	Most recent time when CloudFormation performed a drift detection operation on the stack set.
final ManagedExecution	managedExecution()	Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
final PermissionModels	permissionModel()	Describes how the IAM roles required for stack set operations are created.
final String	permissionModelAsString()	Describes how the IAM roles required for stack set operations are created.
final List<SdkField<?>>	sdkFields()
static Class<? extends StackSetSummary.Builder>	serializableBuilderClass()
final String	stackSetId()	The ID of the stack set.
final String	stackSetName()	The name of the stack set.
final StackSetStatus	status()	The status of the stack set.
final String	statusAsString()	The status of the stack set.
StackSetSummary.Builder	toBuilder()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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 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

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 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

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 return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from driftStatusAsString().

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 return StackDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from driftStatusAsString().

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()

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 interface ToCopyableBuilder<StackSetSummary.Builder,StackSetSummary>

Returns:

a builder for type T

builder

public static StackSetSummary.Builder builder()

serializableBuilderClass

public static Class<? extends StackSetSummary.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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.