OrganizationCustomRuleMetadata

import type { OrganizationCustomRuleMetadata } from "https://aws-api.deno.dev/v0.4/services/configservice.ts?docs=full";

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.

interface OrganizationCustomRuleMetadata {

Description?: string | null;

InputParameters?: string | null;

LambdaFunctionArn: string;

MaximumExecutionFrequency?: MaximumExecutionFrequency | null;

OrganizationConfigRuleTriggerTypes: OrganizationConfigRuleTriggerType[];

ResourceIdScope?: string | null;

ResourceTypesScope?: string[] | null;

TagKeyScope?: string | null;

TagValueScope?: string | null;

}

§Properties

Description?: string | null

[src]

The description that you provide for your organization Config rule.

InputParameters?: string | null

[src]

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

LambdaFunctionArn: string

[src]

The lambda function ARN.

MaximumExecutionFrequency?: MaximumExecutionFrequency | null

[src]

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: By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

OrganizationConfigRuleTriggerTypes: OrganizationConfigRuleTriggerType[]

[src]

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.

ResourceIdScope?: string | null

[src]

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

ResourceTypesScope?: string[] | null

[src]

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

TagKeyScope?: string | null

[src]

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.

TagValueScope?: string | null

[src]

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