Class OrganizationConfigRuleStatus
- java.lang.Object
-
- software.amazon.awssdk.services.config.model.OrganizationConfigRuleStatus
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<OrganizationConfigRuleStatus.Builder,OrganizationConfigRuleStatus>
@Generated("software.amazon.awssdk:codegen") public final class OrganizationConfigRuleStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationConfigRuleStatus.Builder,OrganizationConfigRuleStatus>
Returns the status for an organization Config rule in an organization.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOrganizationConfigRuleStatus.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OrganizationConfigRuleStatus.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringerrorCode()An error code that is returned when organization Config rule creation or deletion has failed.StringerrorMessage()An error message indicating that organization Config rule creation or deletion failed due to an error.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastUpdateTime()The timestamp of the last update.StringorganizationConfigRuleName()The name that you assign to organization Config rule.OrganizationRuleStatusorganizationRuleStatus()Indicates deployment status of an organization Config rule.StringorganizationRuleStatusAsString()Indicates deployment status of an organization Config rule.List<SdkField<?>>sdkFields()static Class<? extends OrganizationConfigRuleStatus.Builder>serializableBuilderClass()OrganizationConfigRuleStatus.BuildertoBuilder()StringtoString()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
-
organizationConfigRuleName
public final String organizationConfigRuleName()
The name that you assign to organization Config rule.
- Returns:
- The name that you assign to organization Config rule.
-
organizationRuleStatus
public final OrganizationRuleStatus organizationRuleStatus()
Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for
config-multiaccountsetup.amazonaws.com.Config sets the state of the rule to:
-
CREATE_SUCCESSFULwhen an organization Config rule has been successfully created in all the member accounts. -
CREATE_IN_PROGRESSwhen an organization Config rule creation is in progress. -
CREATE_FAILEDwhen an organization Config rule creation failed in one or more member accounts within that organization. -
DELETE_FAILEDwhen an organization Config rule deletion failed in one or more member accounts within that organization. -
DELETE_IN_PROGRESSwhen an organization Config rule deletion is in progress. -
DELETE_SUCCESSFULwhen an organization Config rule has been successfully deleted from all the member accounts. -
UPDATE_SUCCESSFULwhen an organization Config rule has been successfully updated in all the member accounts. -
UPDATE_IN_PROGRESSwhen an organization Config rule update is in progress. -
UPDATE_FAILEDwhen an organization Config rule update failed in one or more member accounts within that organization.
If the service returns an enum value that is not available in the current SDK version,
organizationRuleStatuswill returnOrganizationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorganizationRuleStatusAsString().- Returns:
- Indicates deployment status of an organization Config rule. When management account calls
PutOrganizationConfigRule action for the first time, Config rule status is created in all the member
accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule
status is updated in all the member accounts. Additionally, Config rule status is updated when one or
more member accounts join or leave an organization. Config rule status is deleted when the management
account deletes OrganizationConfigRule in all the member accounts and disables service access for
config-multiaccountsetup.amazonaws.com.Config sets the state of the rule to:
-
CREATE_SUCCESSFULwhen an organization Config rule has been successfully created in all the member accounts. -
CREATE_IN_PROGRESSwhen an organization Config rule creation is in progress. -
CREATE_FAILEDwhen an organization Config rule creation failed in one or more member accounts within that organization. -
DELETE_FAILEDwhen an organization Config rule deletion failed in one or more member accounts within that organization. -
DELETE_IN_PROGRESSwhen an organization Config rule deletion is in progress. -
DELETE_SUCCESSFULwhen an organization Config rule has been successfully deleted from all the member accounts. -
UPDATE_SUCCESSFULwhen an organization Config rule has been successfully updated in all the member accounts. -
UPDATE_IN_PROGRESSwhen an organization Config rule update is in progress. -
UPDATE_FAILEDwhen an organization Config rule update failed in one or more member accounts within that organization.
-
- See Also:
OrganizationRuleStatus
-
-
organizationRuleStatusAsString
public final String organizationRuleStatusAsString()
Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for
config-multiaccountsetup.amazonaws.com.Config sets the state of the rule to:
-
CREATE_SUCCESSFULwhen an organization Config rule has been successfully created in all the member accounts. -
CREATE_IN_PROGRESSwhen an organization Config rule creation is in progress. -
CREATE_FAILEDwhen an organization Config rule creation failed in one or more member accounts within that organization. -
DELETE_FAILEDwhen an organization Config rule deletion failed in one or more member accounts within that organization. -
DELETE_IN_PROGRESSwhen an organization Config rule deletion is in progress. -
DELETE_SUCCESSFULwhen an organization Config rule has been successfully deleted from all the member accounts. -
UPDATE_SUCCESSFULwhen an organization Config rule has been successfully updated in all the member accounts. -
UPDATE_IN_PROGRESSwhen an organization Config rule update is in progress. -
UPDATE_FAILEDwhen an organization Config rule update failed in one or more member accounts within that organization.
If the service returns an enum value that is not available in the current SDK version,
organizationRuleStatuswill returnOrganizationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorganizationRuleStatusAsString().- Returns:
- Indicates deployment status of an organization Config rule. When management account calls
PutOrganizationConfigRule action for the first time, Config rule status is created in all the member
accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule
status is updated in all the member accounts. Additionally, Config rule status is updated when one or
more member accounts join or leave an organization. Config rule status is deleted when the management
account deletes OrganizationConfigRule in all the member accounts and disables service access for
config-multiaccountsetup.amazonaws.com.Config sets the state of the rule to:
-
CREATE_SUCCESSFULwhen an organization Config rule has been successfully created in all the member accounts. -
CREATE_IN_PROGRESSwhen an organization Config rule creation is in progress. -
CREATE_FAILEDwhen an organization Config rule creation failed in one or more member accounts within that organization. -
DELETE_FAILEDwhen an organization Config rule deletion failed in one or more member accounts within that organization. -
DELETE_IN_PROGRESSwhen an organization Config rule deletion is in progress. -
DELETE_SUCCESSFULwhen an organization Config rule has been successfully deleted from all the member accounts. -
UPDATE_SUCCESSFULwhen an organization Config rule has been successfully updated in all the member accounts. -
UPDATE_IN_PROGRESSwhen an organization Config rule update is in progress. -
UPDATE_FAILEDwhen an organization Config rule update failed in one or more member accounts within that organization.
-
- See Also:
OrganizationRuleStatus
-
-
errorCode
public final String errorCode()
An error code that is returned when organization Config rule creation or deletion has failed.
- Returns:
- An error code that is returned when organization Config rule creation or deletion has failed.
-
errorMessage
public final String errorMessage()
An error message indicating that organization Config rule creation or deletion failed due to an error.
- Returns:
- An error message indicating that organization Config rule creation or deletion failed due to an error.
-
lastUpdateTime
public final Instant lastUpdateTime()
The timestamp of the last update.
- Returns:
- The timestamp of the last update.
-
toBuilder
public OrganizationConfigRuleStatus.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OrganizationConfigRuleStatus.Builder,OrganizationConfigRuleStatus>
-
builder
public static OrganizationConfigRuleStatus.Builder builder()
-
serializableBuilderClass
public static Class<? extends OrganizationConfigRuleStatus.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
-