File Coverage

blib/lib/Paws/Config/ConfigSnapshotDeliveryProperties.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	sub	time	code
1				package Paws::Config::ConfigSnapshotDeliveryProperties;
2	1	1	535	use Moose;
	1		3
	1		7
3				has DeliveryFrequency => (is => 'ro', isa => 'Str', request_name => 'deliveryFrequency', traits => ['NameInRequest']);
4				1;
5
6				### main pod documentation begin ###
7
8				=head1 NAME
9
10				Paws::Config::ConfigSnapshotDeliveryProperties
11
12				=head1 USAGE
13
14				This class represents one of two things:
15
16				=head3 Arguments in a call to a service
17
18				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
19				Each attribute should be used as a named argument in the calls that expect this type of object.
20
21				As an example, if Att1 is expected to be a Paws::Config::ConfigSnapshotDeliveryProperties object:
22
23				$service_obj->Method(Att1 => { DeliveryFrequency => $value, ..., DeliveryFrequency => $value });
24
25				=head3 Results returned from an API call
26
27				Use accessors for each attribute. If Att1 is expected to be an Paws::Config::ConfigSnapshotDeliveryProperties object:
28
29				$result = $service_obj->Method(...);
30				$result->Att1->DeliveryFrequency
31
32				=head1 DESCRIPTION
33
34				Provides options for how often AWS Config delivers configuration
35				snapshots to the Amazon S3 bucket in your delivery channel.
36
37				If you want to create a rule that triggers evaluations for your
38				resources when AWS Config delivers the configuration snapshot, see the
39				following:
40
41				The frequency for a rule that triggers evaluations for your resources
42				when AWS Config delivers the configuration snapshot is set by one of
43				two values, depending on which is less frequent:
44
45				=over
46
47				=item *
48
49				The value for the C<deliveryFrequency> parameter within the delivery
50				channel configuration, which sets how often AWS Config delivers
51				configuration snapshots. This value also sets how often AWS Config
52				invokes evaluations for Config rules.
53
54				=item *
55
56				The value for the C<MaximumExecutionFrequency> parameter, which sets
57				the maximum frequency with which AWS Config invokes evaluations for the
58				rule. For more information, see ConfigRule.
59
60				=back
61
62				If the C<deliveryFrequency> value is less frequent than the
63				C<MaximumExecutionFrequency> value for a rule, AWS Config invokes the
64				rule only as often as the C<deliveryFrequency> value.
65
66				=over
67
68				=item 1.
69
70				For example, you want your rule to run evaluations when AWS Config
71				delivers the configuration snapshot.
72
73				=item 2.
74
75				You specify the C<MaximumExecutionFrequency> value for C<Six_Hours>.
76
77				=item 3.
78
79				You then specify the delivery channel C<deliveryFrequency> value for
80				C<TwentyFour_Hours>.
81
82				=item 4.
83
84				Because the value for C<deliveryFrequency> is less frequent than
85				C<MaximumExecutionFrequency>, AWS Config invokes evaluations for the
86				rule every 24 hours.
87
88				=back
89
90				You should set the C<MaximumExecutionFrequency> value to be at least as
91				frequent as the C<deliveryFrequency> value. You can view the
92				C<deliveryFrequency> value by using the C<DescribeDeliveryChannnels>
93				action.
94
95				To update the C<deliveryFrequency> with which AWS Config delivers your
96				configuration snapshots, use the C<PutDeliveryChannel> action.
97
98				=head1 ATTRIBUTES
99
100
101				=head2 DeliveryFrequency => Str
102
103				The frequency with which AWS Config delivers configuration snapshots.
104
105
106
107				=head1 SEE ALSO
108
109				This class forms part of L<Paws>, describing an object used in L<Paws::Config>
110
111				=head1 BUGS and CONTRIBUTIONS
112
113				The source code is located here: https://github.com/pplu/aws-sdk-perl
114
115				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
116
117				=cut
118