Documentation

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

See: newOrganizationManagedRuleMetadata smart constructor.

Create a value of OrganizationManagedRuleMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inputParameters:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_inputParameters - A string, in JSON format, that is passed to organization config rule Lambda function.

$sel:resourceIdScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.

$sel:tagValueScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_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).

$sel:maximumExecutionFrequency:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.

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

$sel:tagKeyScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_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.

$sel:resourceTypesScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.

$sel:description:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_description - The description that you provide for organization config rule.

$sel:ruleIdentifier:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_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 Config managed rules.

A string, in JSON format, that is passed to organization config rule Lambda function.

The ID of the Amazon Web Services resource that was evaluated.

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

The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.

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

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.

The type of the Amazon Web Services resource that was evaluated.

The description that you provide for organization config rule.

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 Config managed rules.