Class RoleProvisioning
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic RoleProvisioning.Builderbuilder()final IntegerThe number of accounts that have finished role provisioning, including both succeeded and failed accounts.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final IntegerThe number of accounts for which role provisioning failed.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final IntegerThe number of accounts that are still awaiting role provisioning.final DoubleThe percentage of accounts that have completed role provisioning.static Class<? extends RoleProvisioning.Builder> final StageStatusstatus()The status of the role provisioning stage can be one of the following values:final StringThe status of the role provisioning stage can be one of the following values:final IntegerThe number of accounts for which role provisioning succeeded.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 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,
statuswill returnStageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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
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,
statuswill returnStageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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
The number of accounts for which role provisioning succeeded.
- Returns:
- The number of accounts for which role provisioning succeeded.
-
failedAccountsCount
The number of accounts for which role provisioning failed.
- Returns:
- The number of accounts for which role provisioning failed.
-
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
The number of accounts that are still awaiting role provisioning.
- Returns:
- The number of accounts that are still awaiting role provisioning.
-
percentageCompleted
The percentage of accounts that have completed role provisioning.
- Returns:
- The percentage of accounts that have completed role provisioning.
-
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<RoleProvisioning.Builder,RoleProvisioning> - 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.
-