software.amazon.awssdk.services.config.model

Class OrganizationConfigRuleStatus

java.lang.Object

software.amazon.awssdk.services.config.model.OrganizationConfigRuleStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrganizationConfigRuleStatus.Builder,OrganizationConfigRuleStatus>

@Generated(value="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 and Description
static interface	OrganizationConfigRuleStatus.Builder

Method Summary

Modifier and Type	Method and Description
static OrganizationConfigRuleStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorCode() An error code that is returned when organization Config rule creation or deletion has failed.
String	errorMessage() 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)
int	hashCode()
Instant	lastUpdateTime() The timestamp of the last update.
String	organizationConfigRuleName() The name that you assign to organization Config rule.
OrganizationRuleStatus	organizationRuleStatus() Indicates deployment status of an organization Config rule.
String	organizationRuleStatusAsString() Indicates deployment status of an organization Config rule.
List<SdkField<?>>	sdkFields()
static Class<? extends OrganizationConfigRuleStatus.Builder>	serializableBuilderClass()
OrganizationConfigRuleStatus.Builder	toBuilder()
String	toString() 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_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.

• CREATE_IN_PROGRESS when an organization Config rule creation is in progress.

• CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.

• DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.

• DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.

• DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.

• UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.

• UPDATE_IN_PROGRESS when an organization Config rule update is in progress.

• UPDATE_FAILED when 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, organizationRuleStatus will return OrganizationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from organizationRuleStatusAsString().

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_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.

• CREATE_IN_PROGRESS when an organization Config rule creation is in progress.

• CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.

• DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.

• DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.

• DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.

• UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.

• UPDATE_IN_PROGRESS when an organization Config rule update is in progress.

• UPDATE_FAILED when 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_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.

• CREATE_IN_PROGRESS when an organization Config rule creation is in progress.

• CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.

• DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.

• DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.

• DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.

• UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.

• UPDATE_IN_PROGRESS when an organization Config rule update is in progress.

• UPDATE_FAILED when 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, organizationRuleStatus will return OrganizationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from organizationRuleStatusAsString().

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_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.

• CREATE_IN_PROGRESS when an organization Config rule creation is in progress.

• CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.

• DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.

• DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.

• DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.

• UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.

• UPDATE_IN_PROGRESS when an organization Config rule update is in progress.

• UPDATE_FAILED when 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:

toBuilder in interface ToCopyableBuilder<OrganizationConfigRuleStatus.Builder,OrganizationConfigRuleStatus>

builder

public static OrganizationConfigRuleStatus.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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