File Coverage

blib/lib/Paws/Config/ConfigRule.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Config::ConfigRule;
2 1     1   314 use Moose;
  1         3  
  1         7  
3             has ConfigRuleArn => (is => 'ro', isa => 'Str');
4             has ConfigRuleId => (is => 'ro', isa => 'Str');
5             has ConfigRuleName => (is => 'ro', isa => 'Str');
6             has ConfigRuleState => (is => 'ro', isa => 'Str');
7             has Description => (is => 'ro', isa => 'Str');
8             has InputParameters => (is => 'ro', isa => 'Str');
9             has MaximumExecutionFrequency => (is => 'ro', isa => 'Str');
10             has Scope => (is => 'ro', isa => 'Paws::Config::Scope');
11             has Source => (is => 'ro', isa => 'Paws::Config::Source', required => 1);
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::Config::ConfigRule
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::Config::ConfigRule object:
30              
31             $service_obj->Method(Att1 => { ConfigRuleArn => $value, ..., Source => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::Config::ConfigRule object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->ConfigRuleArn
39              
40             =head1 DESCRIPTION
41              
42             An AWS Config rule represents an AWS Lambda function that you create
43             for a custom rule or a predefined function for an AWS managed rule. The
44             function evaluates configuration items to assess whether your AWS
45             resources comply with your desired configurations. This function can
46             run when AWS Config detects a configuration change to an AWS resource
47             and at a periodic frequency that you choose (for example, every 24
48             hours).
49              
50             You can use the AWS CLI and AWS SDKs if you want to create a rule that
51             triggers evaluations for your resources when AWS Config delivers the
52             configuration snapshot. For more information, see
53             ConfigSnapshotDeliveryProperties.
54              
55             For more information about developing and using AWS Config rules, see
56             Evaluating AWS Resource Configurations with AWS Config in the I<AWS
57             Config Developer Guide>.
58              
59             =head1 ATTRIBUTES
60              
61              
62             =head2 ConfigRuleArn => Str
63              
64             The Amazon Resource Name (ARN) of the AWS Config rule.
65              
66              
67             =head2 ConfigRuleId => Str
68              
69             The ID of the AWS Config rule.
70              
71              
72             =head2 ConfigRuleName => Str
73              
74             The name that you assign to the AWS Config rule. The name is required
75             if you are adding a new rule.
76              
77              
78             =head2 ConfigRuleState => Str
79              
80             Indicates whether the AWS Config rule is active or is currently being
81             deleted by AWS Config. It can also indicate the evaluation status for
82             the Config rule.
83              
84             AWS Config sets the state of the rule to C<EVALUATING> temporarily
85             after you use the C<StartConfigRulesEvaluation> request to evaluate
86             your resources against the Config rule.
87              
88             AWS Config sets the state of the rule to C<DELETING_RESULTS>
89             temporarily after you use the C<DeleteEvaluationResults> request to
90             delete the current evaluation results for the Config rule.
91              
92             AWS Config sets the state of a rule to C<DELETING> temporarily after
93             you use the C<DeleteConfigRule> request to delete the rule. After AWS
94             Config deletes the rule, the rule and all of its evaluations are erased
95             and are no longer available.
96              
97              
98             =head2 Description => Str
99              
100             The description that you provide for the AWS Config rule.
101              
102              
103             =head2 InputParameters => Str
104              
105             A string in JSON format that is passed to the AWS Config rule Lambda
106             function.
107              
108              
109             =head2 MaximumExecutionFrequency => Str
110              
111             The maximum frequency with which AWS Config runs evaluations for a
112             rule. You can specify a value for C<MaximumExecutionFrequency> when:
113              
114             =over
115              
116             =item *
117              
118             You are using an AWS managed rule that is triggered at a periodic
119             frequency.
120              
121             =item *
122              
123             Your custom rule is triggered when AWS Config delivers the
124             configuration snapshot. For more information, see
125             ConfigSnapshotDeliveryProperties.
126              
127             =back
128              
129             By default, rules with a periodic trigger are evaluated every 24 hours.
130             To change the frequency, specify a valid value for the
131             C<MaximumExecutionFrequency> parameter.
132              
133              
134             =head2 Scope => L<Paws::Config::Scope>
135              
136             Defines which resources can trigger an evaluation for the rule. The
137             scope can include one or more resource types, a combination of one
138             resource type and one resource ID, or a combination of a tag key and
139             value. Specify a scope to constrain the resources that can trigger an
140             evaluation for the rule. If you do not specify a scope, evaluations are
141             triggered when any resource in the recording group changes.
142              
143              
144             =head2 B<REQUIRED> Source => L<Paws::Config::Source>
145              
146             Provides the rule owner (AWS or customer), the rule identifier, and the
147             notifications that cause the function to evaluate your AWS resources.
148              
149              
150              
151             =head1 SEE ALSO
152              
153             This class forms part of L<Paws>, describing an object used in L<Paws::Config>
154              
155             =head1 BUGS and CONTRIBUTIONS
156              
157             The source code is located here: https://github.com/pplu/aws-sdk-perl
158              
159             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
160              
161             =cut
162