Class StackSetOperationResultSummary
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.StackSetOperationResultSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>
@Generated("software.amazon.awssdk:codegen") public final class StackSetOperationResultSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>
The structure that contains information about a specified operation's results for a given account in a given Region.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StackSetOperationResultSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
account()
[Self-managed permissions] The name of the Amazon Web Services account for this operation result.AccountGateResult
accountGateResult()
The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.static StackSetOperationResultSummary.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
organizationalUnitId()
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.String
region()
The name of the Amazon Web Services Region for this operation result.List<SdkField<?>>
sdkFields()
static Class<? extends StackSetOperationResultSummary.Builder>
serializableBuilderClass()
StackSetOperationResultStatus
status()
The result status of the stack set operation for the given account in the given Region.String
statusAsString()
The result status of the stack set operation for the given account in the given Region.String
statusReason()
The reason for the assigned result status.StackSetOperationResultSummary.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
-
account
public final String account()
[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
- Returns:
- [Self-managed permissions] The name of the Amazon Web Services account for this operation result.
-
region
public final String region()
The name of the Amazon Web Services Region for this operation result.
- Returns:
- The name of the Amazon Web Services Region for this operation result.
-
status
public final StackSetOperationResultStatus status()
The result status of the stack set operation for the given account in the given Region.
-
CANCELLED
: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. -
FAILED
: The operation in the specified account and Region failed.If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
-
RUNNING
: The operation in the specified account and Region is currently in progress. -
PENDING
: The operation in the specified account and Region has yet to start. -
SUCCEEDED
: The operation in the specified account and Region completed successfully.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStackSetOperationResultStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The result status of the stack set operation for the given account in the given Region.
-
CANCELLED
: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. -
FAILED
: The operation in the specified account and Region failed.If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
-
RUNNING
: The operation in the specified account and Region is currently in progress. -
PENDING
: The operation in the specified account and Region has yet to start. -
SUCCEEDED
: The operation in the specified account and Region completed successfully.
-
- See Also:
StackSetOperationResultStatus
-
-
statusAsString
public final String statusAsString()
The result status of the stack set operation for the given account in the given Region.
-
CANCELLED
: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. -
FAILED
: The operation in the specified account and Region failed.If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
-
RUNNING
: The operation in the specified account and Region is currently in progress. -
PENDING
: The operation in the specified account and Region has yet to start. -
SUCCEEDED
: The operation in the specified account and Region completed successfully.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStackSetOperationResultStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The result status of the stack set operation for the given account in the given Region.
-
CANCELLED
: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. -
FAILED
: The operation in the specified account and Region failed.If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.
-
RUNNING
: The operation in the specified account and Region is currently in progress. -
PENDING
: The operation in the specified account and Region has yet to start. -
SUCCEEDED
: The operation in the specified account and Region completed successfully.
-
- See Also:
StackSetOperationResultStatus
-
-
statusReason
public final String statusReason()
The reason for the assigned result status.
- Returns:
- The reason for the assigned result status.
-
accountGateResult
public final AccountGateResult accountGateResult()
The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.
- Returns:
- The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.
-
organizationalUnitId
public final String organizationalUnitId()
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
- Returns:
- [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
-
toBuilder
public StackSetOperationResultSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>
-
builder
public static StackSetOperationResultSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends StackSetOperationResultSummary.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.
-
-