File Coverage

blib/lib/Paws/Config/SourceDetail.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::SourceDetail;
2 1     1   461 use Moose;
  1         3  
  1         8  
3             has EventSource => (is => 'ro', isa => 'Str');
4             has MaximumExecutionFrequency => (is => 'ro', isa => 'Str');
5             has MessageType => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::Config::SourceDetail
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::Config::SourceDetail object:
24              
25             $service_obj->Method(Att1 => { EventSource => $value, ..., MessageType => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::Config::SourceDetail object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->EventSource
33              
34             =head1 DESCRIPTION
35              
36             Provides the source and the message types that trigger AWS Config to
37             evaluate your AWS resources against a rule. It also provides the
38             frequency with which you want AWS Config to run evaluations for the
39             rule if the trigger type is periodic. You can specify the parameter
40             values for C<SourceDetail> only for custom rules.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 EventSource => Str
46              
47             The source of the event, such as an AWS service, that triggers AWS
48             Config to evaluate your AWS resources.
49              
50              
51             =head2 MaximumExecutionFrequency => Str
52              
53             The frequency that you want AWS Config to run evaluations for a custom
54             rule with a periodic trigger. If you specify a value for
55             C<MaximumExecutionFrequency>, then C<MessageType> must use the
56             C<ScheduledNotification> value.
57              
58             By default, rules with a periodic trigger are evaluated every 24 hours.
59             To change the frequency, specify a valid value for the
60             C<MaximumExecutionFrequency> parameter.
61              
62              
63             =head2 MessageType => Str
64              
65             The type of notification that triggers AWS Config to run an evaluation
66             for a rule. You can specify the following notification types:
67              
68             =over
69              
70             =item *
71              
72             C<ConfigurationItemChangeNotification> - Triggers an evaluation when
73             AWS Config delivers a configuration item as a result of a resource
74             change.
75              
76             =item *
77              
78             C<OversizedConfigurationItemChangeNotification> - Triggers an
79             evaluation when AWS Config delivers an oversized configuration item.
80             AWS Config may generate this notification type when a resource changes
81             and the notification exceeds the maximum size allowed by Amazon SNS.
82              
83             =item *
84              
85             C<ScheduledNotification> - Triggers a periodic evaluation at the
86             frequency specified for C<MaximumExecutionFrequency>.
87              
88             =item *
89              
90             C<ConfigurationSnapshotDeliveryCompleted> - Triggers a periodic
91             evaluation when AWS Config delivers a configuration snapshot.
92              
93             =back
94              
95             If you want your custom rule to be triggered by configuration changes,
96             specify both C<ConfigurationItemChangeNotification> and
97             C<OversizedConfigurationItemChangeNotification>.
98              
99              
100              
101             =head1 SEE ALSO
102              
103             This class forms part of L<Paws>, describing an object used in L<Paws::Config>
104              
105             =head1 BUGS and CONTRIBUTIONS
106              
107             The source code is located here: https://github.com/pplu/aws-sdk-perl
108              
109             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
110              
111             =cut
112