Class: Aws::ConfigService::Types::OrganizationCustomRuleMetadata
- Inherits:
-
Struct
- Object
- Struct
- Aws::ConfigService::Types::OrganizationCustomRuleMetadata
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-configservice/types.rb
Overview
When making an API call, you may pass OrganizationCustomRuleMetadata data as a hash:
{
description: "StringWithCharLimit256Min0",
lambda_function_arn: "StringWithCharLimit256", # required
organization_config_rule_trigger_types: ["ConfigurationItemChangeNotification"], # required, accepts ConfigurationItemChangeNotification, OversizedConfigurationItemChangeNotification, ScheduledNotification
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",
}
An object that specifies organization custom rule metadata such as resource type, resource ID of AWS resource, Lamdba function ARN, and organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#description ⇒ String
The description that you provide for organization config rule.
-
#input_parameters ⇒ String
A string, in JSON format, that is passed to organization config rule Lambda function.
-
#lambda_function_arn ⇒ String
The lambda function ARN.
-
#maximum_execution_frequency ⇒ String
The maximum frequency with which AWS Config runs evaluations for a rule.
-
#organization_config_rule_trigger_types ⇒ Array<String>
The type of notification that triggers AWS Config to run an evaluation for a rule.
-
#resource_id_scope ⇒ String
The ID of the AWS resource that was evaluated.
-
#resource_types_scope ⇒ Array<String>
The type of the AWS 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
#description ⇒ String
The description that you provide for organization config rule.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |
#input_parameters ⇒ String
A string, in JSON format, that is passed to organization config rule Lambda function.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |
#lambda_function_arn ⇒ String
The lambda function ARN.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |
#maximum_execution_frequency ⇒ String
The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
<note markdown=“1”> By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ‘MaximumExecutionFrequency` parameter.
</note>
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |
#organization_config_rule_trigger_types ⇒ Array<String>
The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:
-
‘ConfigurationItemChangeNotification` - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.
-
‘OversizedConfigurationItemChangeNotification` - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
-
‘ScheduledNotification` - Triggers a periodic evaluation at the frequency specified for `MaximumExecutionFrequency`.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |
#resource_id_scope ⇒ String
The ID of the AWS resource that was evaluated.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |
#resource_types_scope ⇒ Array<String>
The type of the AWS resource that was evaluated.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) 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.
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) 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).
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 |
# File 'lib/aws-sdk-configservice/types.rb', line 6134 class OrganizationCustomRuleMetadata < Struct.new( :description, :lambda_function_arn, :organization_config_rule_trigger_types, :input_parameters, :maximum_execution_frequency, :resource_types_scope, :resource_id_scope, :tag_key_scope, :tag_value_scope) SENSITIVE = [] include Aws::Structure end |