Class RegionalStackInstancesDeployment

java.lang.Object
software.amazon.awssdk.services.cloudformation.model.RegionalStackInstancesDeployment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RegionalStackInstancesDeployment.Builder,RegionalStackInstancesDeployment>

@Generated("software.amazon.awssdk:codegen") public final class RegionalStackInstancesDeployment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RegionalStackInstancesDeployment.Builder,RegionalStackInstancesDeployment>

Provides visibility into the stack instances deployment stage for a single Region, including per-stack-instance progress counts and a completion percentage for that Region.

See Also:
  • Method Details

    • status

      public final StageStatus 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, status will return StageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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

      public final String 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, status will return StageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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

      public final Integer succeededStackInstancesCount()

      The number of stack instances that deployed successfully in this Region.

      Returns:
      The number of stack instances that deployed successfully in this Region.
    • failedStackInstancesCount

      public final Integer failedStackInstancesCount()

      The number of stack instances that failed to deploy in this Region.

      Returns:
      The number of stack instances that failed to deploy in this Region.
    • completedStackInstancesCount

      public final Integer completedStackInstancesCount()

      The number of stack instances in this Region 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 in this Region that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
    • pendingStackInstancesCount

      public final Integer pendingStackInstancesCount()

      The number of stack instances in this Region that have not reached a final state. This is the total number of stack instances in this Region minus the completed count.

      Returns:
      The number of stack instances in this Region that have not reached a final state. This is the total number of stack instances in this Region minus the completed count.
    • cancelledStackInstancesCount

      public final Integer cancelledStackInstancesCount()

      The number of stack instances in this Region that were canceled because the operation exceeded its failure tolerance or was stopped.

      Returns:
      The number of stack instances in this Region that were canceled because the operation exceeded its failure tolerance or was stopped.
    • skippedStackInstancesCount

      public final Integer skippedStackInstancesCount()

      The number of stack instances in this Region that were skipped because role provisioning failed for their target account.

      Returns:
      The number of stack instances in this Region that were skipped because role provisioning failed for their target account.
    • totalStackInstancesCount

      public final Integer totalStackInstancesCount()

      The total number of stack instances targeted by this operation in this Region.

      Returns:
      The total number of stack instances targeted by this operation in this Region.
    • percentageCompleted

      public final Double percentageCompleted()

      The percentage of stack instances in this Region that have reached a final state.

      Returns:
      The percentage of stack instances in this Region that have reached a final state.
    • 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<RegionalStackInstancesDeployment.Builder,RegionalStackInstancesDeployment>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends RegionalStackInstancesDeployment.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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.