OrganizationCustomRuleMetadata - Amazon Config
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

OrganizationCustomRuleMetadata

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon resource, Lambda function ARN, and organization trigger types that trigger Amazon Config to evaluate your Amazon resources against a rule. It also provides the frequency with which you want Amazon Config to run evaluations for the rule if the trigger type is periodic.

Contents

LambdaFunctionArn

The lambda function ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

OrganizationConfigRuleTriggerTypes

The type of notification that triggers Amazon Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Amazon Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Amazon Config delivers an oversized configuration item. Amazon 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.

Type: Array of strings

Valid Values: ConfigurationItemChangeNotification | OversizedConfigurationItemChangeNotification | ScheduledNotification

Required: Yes

Description

The description that you provide for your organization Amazon Config rule.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

InputParameters

A string, in JSON format, that is passed to your organization Amazon Config rule Lambda function.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

MaximumExecutionFrequency

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

Note

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Type: String

Valid Values: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours

Required: No

ResourceIdScope

The ID of the Amazon resource that was evaluated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 768.

Required: No

ResourceTypesScope

The type of the Amazon resource that was evaluated.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

TagKeyScope

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

TagValueScope

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: