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:

  • Method Details

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

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

    • 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()
      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<OrganizationConfigRuleStatus.Builder,OrganizationConfigRuleStatus>
      Returns:
      a builder for type T

    • 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)
      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.