Class RoleProvisioning

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

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

Provides visibility into the role provisioning stage of a StackSet operation, including per-account progress counts and a completion percentage. For operations that do not provision IAM roles in target accounts, the Status is NOT_APPLICABLE and the progress counts are omitted.

See Also:
  • Method Details

    • status

      public final StageStatus status()

      The status of the role provisioning stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not provision roles. This includes self-managed operations and service-managed operations whose configuration does not require role provisioning.

      • NOT_STARTED: Role provisioning has not started. The operation has not begun resolving target accounts, or it failed or stopped before the total number of target accounts was resolved.

      • IN_PROGRESS: Role provisioning is actively processing target accounts.

      • SUCCEEDED: Role provisioning finished and succeeded for all target accounts.

      • PARTIAL_SUCCESS: Role provisioning finished, but succeeded for only a subset of target accounts; one or more accounts failed.

      • FAILED: Role provisioning finished and failed for all target accounts.

      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 role provisioning stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not provision roles. This includes self-managed operations and service-managed operations whose configuration does not require role provisioning.

      • NOT_STARTED: Role provisioning has not started. The operation has not begun resolving target accounts, or it failed or stopped before the total number of target accounts was resolved.

      • IN_PROGRESS: Role provisioning is actively processing target accounts.

      • SUCCEEDED: Role provisioning finished and succeeded for all target accounts.

      • PARTIAL_SUCCESS: Role provisioning finished, but succeeded for only a subset of target accounts; one or more accounts failed.

      • FAILED: Role provisioning finished and failed for all target accounts.

      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the role provisioning stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not provision roles. This includes self-managed operations and service-managed operations whose configuration does not require role provisioning.

      • NOT_STARTED: Role provisioning has not started. The operation has not begun resolving target accounts, or it failed or stopped before the total number of target accounts was resolved.

      • IN_PROGRESS: Role provisioning is actively processing target accounts.

      • SUCCEEDED: Role provisioning finished and succeeded for all target accounts.

      • PARTIAL_SUCCESS: Role provisioning finished, but succeeded for only a subset of target accounts; one or more accounts failed.

      • FAILED: Role provisioning finished and failed for all target accounts.

      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 role provisioning stage can be one of the following values:

      • NOT_APPLICABLE: The operation does not provision roles. This includes self-managed operations and service-managed operations whose configuration does not require role provisioning.

      • NOT_STARTED: Role provisioning has not started. The operation has not begun resolving target accounts, or it failed or stopped before the total number of target accounts was resolved.

      • IN_PROGRESS: Role provisioning is actively processing target accounts.

      • SUCCEEDED: Role provisioning finished and succeeded for all target accounts.

      • PARTIAL_SUCCESS: Role provisioning finished, but succeeded for only a subset of target accounts; one or more accounts failed.

      • FAILED: Role provisioning finished and failed for all target accounts.

      See Also:
    • succeededAccountsCount

      public final Integer succeededAccountsCount()

      The number of accounts for which role provisioning succeeded.

      Returns:
      The number of accounts for which role provisioning succeeded.
    • failedAccountsCount

      public final Integer failedAccountsCount()

      The number of accounts for which role provisioning failed.

      Returns:
      The number of accounts for which role provisioning failed.
    • completedAccountsCount

      public final Integer completedAccountsCount()

      The number of accounts that have finished role provisioning, including both succeeded and failed accounts.

      Returns:
      The number of accounts that have finished role provisioning, including both succeeded and failed accounts.
    • pendingAccountsCount

      public final Integer pendingAccountsCount()

      The number of accounts that are still awaiting role provisioning.

      Returns:
      The number of accounts that are still awaiting role provisioning.
    • percentageCompleted

      public final Double percentageCompleted()

      The percentage of accounts that have completed role provisioning.

      Returns:
      The percentage of accounts that have completed role provisioning.
    • toBuilder

      public RoleProvisioning.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<RoleProvisioning.Builder,RoleProvisioning>
      Returns:
      a builder for type T
    • builder

      public static RoleProvisioning.Builder builder()
    • serializableBuilderClass

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