The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Config::OrganizationCustomRuleMetadata

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Config::OrganizationCustomRuleMetadata object:

  $service_obj->Method(Att1 => { Description => $value, ..., TagValueScope => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Config::OrganizationCustomRuleMetadata object:

  $result = $service_obj->Method(...);
  $result->Att1->Description

DESCRIPTION

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

ATTRIBUTES

Description => Str

The description that you provide for organization config rule.

InputParameters => Str

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

REQUIRED LambdaFunctionArn => Str

The lambda function ARN.

MaximumExecutionFrequency => Str

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

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

REQUIRED OrganizationConfigRuleTriggerTypes => ArrayRef[Str|Undef]

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following 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.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

ResourceIdScope => Str

The ID of the AWS resource that was evaluated.

ResourceTypesScope => ArrayRef[Str|Undef]

The type of the AWS resource that was evaluated.

TagKeyScope => Str

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 => Str

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Config

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues