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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_codeString

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

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 5829

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

#error_messageString

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

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 5829

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_timeTime

The timestamp of the last update.

Returns:

  • (Time)


5829
5830
5831
5832
5833
5834
5835
5836
5837
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 5829

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_nameString

The name that you assign to organization config rule.

Returns:

  • (String)


5829
5830
5831
5832
5833
5834
5835
5836
5837
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 5829

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_statusString

Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master 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 master 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)


5829
5830
5831
5832
5833
5834
5835
5836
5837
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 5829

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