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

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

Overview

Note:

When making an API call, you may pass OrganizationCustomPolicyRuleMetadata data as a hash:

{
  description: "StringWithCharLimit256Min0",
  organization_config_rule_trigger_types: ["ConfigurationItemChangeNotification"], # accepts ConfigurationItemChangeNotification, OversizedConfigurationItemChangeNotification
  input_parameters: "StringWithCharLimit2048",
  maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
  resource_types_scope: ["StringWithCharLimit256"],
  resource_id_scope: "StringWithCharLimit768",
  tag_key_scope: "StringWithCharLimit128",
  tag_value_scope: "StringWithCharLimit256",
  policy_runtime: "PolicyRuntime", # required
  policy_text: "PolicyText", # required
  debug_log_delivery_accounts: ["AccountId"],
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#debug_log_delivery_accountsArray<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>)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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

#descriptionString

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

Returns:

  • (String)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_parametersString

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

Returns:

  • (String)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_frequencyString

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)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_typesArray<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>)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_runtimeString

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.

Returns:

  • (String)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_textString

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

Returns:

  • (String)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_scopeString

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

Returns:

  • (String)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_scopeArray<String>

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

Returns:

  • (Array<String>)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_scopeString

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)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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_scopeString

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)


6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6302

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