class Aws::ConfigService::Types::OrganizationCustomRuleMetadata
An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
@note 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", }
@!attribute [rw] description
The description that you provide for organization config rule. @return [String]
@!attribute [rw] lambda_function_arn
The lambda function ARN. @return [String]
@!attribute [rw] organization_config_rule_trigger_types
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types: * `ConfigurationItemChangeNotification` - Triggers an evaluation when Config delivers a configuration item as a result of a resource change. * `OversizedConfigurationItemChangeNotification` - Triggers 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. * `ScheduledNotification` - Triggers a periodic evaluation at the frequency specified for `MaximumExecutionFrequency`. @return [Array<String>]
@!attribute [rw] input_parameters
A string, in JSON format, that is passed to organization config rule Lambda function. @return [String]
@!attribute [rw] maximum_execution_frequency
The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when 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> @return [String]
@!attribute [rw] resource_types_scope
The type of the Amazon Web Services resource that was evaluated. @return [Array<String>]
@!attribute [rw] resource_id_scope
The ID of the Amazon Web Services resource that was evaluated. @return [String]
@!attribute [rw] tag_key_scope
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. @return [String]
@!attribute [rw] tag_value_scope
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). @return [String]
@see docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/OrganizationCustomRuleMetadata AWS API Documentation
Constants
- SENSITIVE