Class: Aws::ConfigService::Types::OrganizationConfigRuleStatus

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::OrganizationConfigRuleStatus

Includes:

Structure

Defined in:

lib/aws-sdk-configservice/types.rb

Overview

Returns the status for an organization Config rule in an organization.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #error_code ⇒ String

  An error code that is returned when organization Config rule creation or deletion has failed.

• #error_message ⇒ String

  An error message indicating that organization Config rule creation or deletion failed due to an error.

• #last_update_time ⇒ Time

  The timestamp of the last update.

• #organization_config_rule_name ⇒ String

  The name that you assign to organization Config rule.

• #organization_rule_status ⇒ String

  Indicates deployment status of an organization Config rule.

Instance Attribute Details

#error_code ⇒ String

An error code that is returned when organization Config rule creation or deletion has failed.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6223

class OrganizationConfigRuleStatus < Struct.new(
  :organization_config_rule_name,
  :organization_rule_status,
  :error_code,
  :error_message,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

An error message indicating that organization Config rule creation or deletion failed due to an error.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6223

class OrganizationConfigRuleStatus < Struct.new(
  :organization_config_rule_name,
  :organization_rule_status,
  :error_code,
  :error_message,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

The timestamp of the last update.

Returns:

• (Time)

# File 'lib/aws-sdk-configservice/types.rb', line 6223

class OrganizationConfigRuleStatus < Struct.new(
  :organization_config_rule_name,
  :organization_rule_status,
  :error_code,
  :error_message,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#organization_config_rule_name ⇒ String

The name that you assign to organization Config rule.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6223

class OrganizationConfigRuleStatus < Struct.new(
  :organization_config_rule_name,
  :organization_rule_status,
  :error_code,
  :error_message,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end

#organization_rule_status ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6223

class OrganizationConfigRuleStatus < Struct.new(
  :organization_config_rule_name,
  :organization_rule_status,
  :error_code,
  :error_message,
  :last_update_time)
  SENSITIVE = []
  include Aws::Structure
end