OrganizationCustomPolicyRuleMetadataNoPolicy
metadata for your organization AWS Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of AWS resource, and organization trigger types that trigger AWS Config to evaluate AWS resources against a rule.
Contents
- DebugLogDeliveryAccounts
-
A list of accounts that you can enable debug logging for your organization AWS Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Pattern:
\d{12}
Required: No
- Description
-
The description that you provide for your organization AWS Config Custom Policy 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 AWS Config Custom Policy rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- MaximumExecutionFrequency
-
The maximum frequency with which AWS Config runs evaluations for a rule. Your AWS Config Custom Policy rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
Type: String
Valid Values:
One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours
Required: No
- OrganizationConfigRuleTriggerTypes
-
The type of notification that triggers AWS Config to run an evaluation for a rule. For AWS Config Custom Policy rules, AWS Config supports change triggered 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.
Type: Array of strings
Valid Values:
ConfigurationItemChangeNotification | OversizedConfigurationItemChangeNotification
Required: No
-
- PolicyRuntime
-
The runtime system for your organization AWS Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by AWS Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository
. Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
guard\-2\.x\.x
Required: No
- ResourceIdScope
-
The ID of the AWS resource that was evaluated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 768.
Required: No
- ResourceTypesScope
-
The type of the AWS 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 AWS SDKs, see the following: