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