Class: Aws::ConfigService::Types::OrganizationCustomPolicyRuleMetadata

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::OrganizationCustomPolicyRuleMetadata

Includes:

Structure

Defined in:

lib/aws-sdk-configservice/types.rb

Overview

An object that specifies metadata for your organization’s Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #debug_log_delivery_accounts ⇒ Array<String>

  A list of accounts that you can enable debug logging for your organization Config Custom Policy rule.

• #description ⇒ String

  The description that you provide for your organization Config Custom Policy rule.

• #input_parameters ⇒ String

  A string, in JSON format, that is passed to your organization Config Custom Policy rule.

• #maximum_execution_frequency ⇒ String

  The maximum frequency with which Config runs evaluations for a rule.

• #organization_config_rule_trigger_types ⇒ Array<String>

  The type of notification that initiates Config to run an evaluation for a rule.

• #policy_runtime ⇒ String

  The runtime system for your organization Config Custom Policy rules.

• #policy_text ⇒ String

  The policy definition containing the logic for your organization Config Custom Policy rule.

• #resource_id_scope ⇒ String

  The ID of the Amazon Web Services resource that was evaluated.

• #resource_types_scope ⇒ Array<String>

  The type of the Amazon Web Services resource that was evaluated.

• #tag_key_scope ⇒ String

  One part of a key-value pair that make up a tag.

• #tag_value_scope ⇒ String

  The optional part of a key-value pair that make up a tag.

Instance Attribute Details

#debug_log_delivery_accounts ⇒ Array<String>

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

Returns:

• (Array<String>)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description that you provide for your organization Config Custom Policy rule.

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#input_parameters ⇒ String

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_execution_frequency ⇒ String

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#organization_config_rule_trigger_types ⇒ Array<String>

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

• ‘ConfigurationItemChangeNotification` - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

• ‘OversizedConfigurationItemChangeNotification` - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

Returns:

• (Array<String>)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#policy_runtime ⇒ String

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository].

[1]: github.com/aws-cloudformation/cloudformation-guard

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#policy_text ⇒ String

The policy definition containing the logic for your organization Config Custom Policy rule.

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id_scope ⇒ String

The ID of the Amazon Web Services resource that was evaluated.

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types_scope ⇒ Array<String>

The type of the Amazon Web Services resource that was evaluated.

Returns:

• (Array<String>)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#tag_key_scope ⇒ String

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end

#tag_value_scope ⇒ String

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Returns:

• (String)

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

class OrganizationCustomPolicyRuleMetadata < Struct.new(
  :description,
  :organization_config_rule_trigger_types,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope,
  :policy_runtime,
  :policy_text,
  :debug_log_delivery_accounts)
  SENSITIVE = []
  include Aws::Structure
end