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