Class StackInstancesDeployment
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<StackInstancesDeployment.Builder,StackInstancesDeployment>
Provides visibility into the stack instances deployment stage of a StackSet operation, including per-stack-instance progress counts and a completion percentage. For service-managed operations that provision roles, this stage begins after role provisioning finishes.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final IntegerThe number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.final IntegerThe number of stack instances that have reached a final state.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final IntegerThe number of stack instances that failed to deploy.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final IntegerThe number of stack instances that have not reached a final state.final DoubleThe percentage of stack instances that have reached a final state.static Class<? extends StackInstancesDeployment.Builder> final IntegerThe number of stack instances that were skipped because role provisioning failed for their target account.final StageStatusstatus()The status of the stack instances deployment stage can be one of the following values:final StringThe status of the stack instances deployment stage can be one of the following values:final IntegerThe number of stack instances that deployed successfully.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
status
The status of the stack instances deployment stage can be one of the following values:
-
NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation. -
NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached. -
IN_PROGRESS: At least one stack instance has started deploying. -
SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped. -
PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances. -
FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the stack instances deployment stage can be one of the following values:
-
NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation. -
NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached. -
IN_PROGRESS: At least one stack instance has started deploying. -
SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped. -
PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances. -
FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
-
- See Also:
-
-
statusAsString
The status of the stack instances deployment stage can be one of the following values:
-
NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation. -
NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached. -
IN_PROGRESS: At least one stack instance has started deploying. -
SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped. -
PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances. -
FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the stack instances deployment stage can be one of the following values:
-
NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation. -
NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached. -
IN_PROGRESS: At least one stack instance has started deploying. -
SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped. -
PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances. -
FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
-
- See Also:
-
-
succeededStackInstancesCount
The number of stack instances that deployed successfully.
- Returns:
- The number of stack instances that deployed successfully.
-
failedStackInstancesCount
The number of stack instances that failed to deploy.
- Returns:
- The number of stack instances that failed to deploy.
-
completedStackInstancesCount
The number of stack instances that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
- Returns:
- The number of stack instances that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
-
pendingStackInstancesCount
The number of stack instances that have not reached a final state. This is the total number of stack instances minus the completed count.
- Returns:
- The number of stack instances that have not reached a final state. This is the total number of stack instances minus the completed count.
-
cancelledStackInstancesCount
The number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.
- Returns:
- The number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.
-
skippedStackInstancesCount
The number of stack instances that were skipped because role provisioning failed for their target account.
- Returns:
- The number of stack instances that were skipped because role provisioning failed for their target account.
-
percentageCompleted
The percentage of stack instances that have reached a final state.
- Returns:
- The percentage of stack instances that have reached a final state.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<StackInstancesDeployment.Builder,StackInstancesDeployment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-