« blib/lib/Paws/Config/OrganizationConformancePackStatus.pm
↑ Summary
blib/lib/Paws/Config/OrganizationManagedRuleMetadata.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::OrganizationCustomRuleMetadata; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has InputParameters => (is => 'ro', isa => 'Str'); | ||
| 6 | has LambdaFunctionArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has MaximumExecutionFrequency => (is => 'ro', isa => 'Str'); | ||
| 8 | has OrganizationConfigRuleTriggerTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 9 | has ResourceIdScope => (is => 'ro', isa => 'Str'); | ||
| 10 | has ResourceTypesScope => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has TagKeyScope => (is => 'ro', isa => 'Str'); | ||
| 12 | has TagValueScope => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Config::OrganizationCustomRuleMetadata | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Config::OrganizationCustomRuleMetadata object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Description => $value, ..., TagValueScope => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Config::OrganizationCustomRuleMetadata object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Description | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | An object that specifies organization custom rule metadata such as | ||
| 45 | resource type, resource ID of AWS resource, Lamdba function ARN, and | ||
| 46 | organization trigger types that trigger AWS Config to evaluate your AWS | ||
| 47 | resources against a rule. It also provides the frequency with which you | ||
| 48 | want AWS Config to run evaluations for the rule if the trigger type is | ||
| 49 | periodic. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Description => Str | ||
| 55 | |||
| 56 | The description that you provide for organization config rule. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 InputParameters => Str | ||
| 60 | |||
| 61 | A string, in JSON format, that is passed to organization config rule | ||
| 62 | Lambda function. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> LambdaFunctionArn => Str | ||
| 66 | |||
| 67 | The lambda function ARN. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 MaximumExecutionFrequency => Str | ||
| 71 | |||
| 72 | The maximum frequency with which AWS Config runs evaluations for a | ||
| 73 | rule. Your custom rule is triggered when AWS Config delivers the | ||
| 74 | configuration snapshot. For more information, see | ||
| 75 | ConfigSnapshotDeliveryProperties. | ||
| 76 | |||
| 77 | By default, rules with a periodic trigger are evaluated every 24 hours. | ||
| 78 | To change the frequency, specify a valid value for the | ||
| 79 | C<MaximumExecutionFrequency> parameter. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> OrganizationConfigRuleTriggerTypes => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | The type of notification that triggers AWS Config to run an evaluation | ||
| 85 | for a rule. You can specify the following notification types: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<ConfigurationItemChangeNotification> - Triggers an evaluation when | ||
| 92 | AWS Config delivers a configuration item as a result of a resource | ||
| 93 | change. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<OversizedConfigurationItemChangeNotification> - Triggers an | ||
| 98 | evaluation when AWS Config delivers an oversized configuration item. | ||
| 99 | AWS Config may generate this notification type when a resource changes | ||
| 100 | and the notification exceeds the maximum size allowed by Amazon SNS. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<ScheduledNotification> - Triggers a periodic evaluation at the | ||
| 105 | frequency specified for C<MaximumExecutionFrequency>. | ||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 ResourceIdScope => Str | ||
| 112 | |||
| 113 | The ID of the AWS resource that was evaluated. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 ResourceTypesScope => ArrayRef[Str|Undef] | ||
| 117 | |||
| 118 | The type of the AWS resource that was evaluated. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 TagKeyScope => Str | ||
| 122 | |||
| 123 | One part of a key-value pair that make up a tag. A key is a general | ||
| 124 | label that acts like a category for more specific tag values. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 TagValueScope => Str | ||
| 128 | |||
| 129 | The optional part of a key-value pair that make up a tag. A value acts | ||
| 130 | as a descriptor within a tag category (key). | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |