OrganizationManagedRuleMetadata
An object that specifies organization managed rule metadata such as resource type and ID of Amazon resource along with the rule identifier. It also provides the frequency with which you want Amazon Config to run evaluations for the rule if the trigger type is periodic.
Contents
- RuleIdentifier
-
For organization config managed rules, a predefined identifier from a list. For example,
IAM_PASSWORD_POLICY
is a managed rule. To reference a managed rule, see Using Amazon Config managed rules.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
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. This is for an Amazon Config managed rule that is triggered at a periodic frequency.
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: