« blib/lib/Paws/SES/DescribeReceiptRuleSetResponse.pm
↑ Summary
blib/lib/Paws/SES/ExtensionField.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SES::EventDestination; | ||
| 3 | use Moose; | ||
| 4 | has CloudWatchDestination => (is => 'ro', isa => 'Paws::SES::CloudWatchDestination'); | ||
| 5 | has Enabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has KinesisFirehoseDestination => (is => 'ro', isa => 'Paws::SES::KinesisFirehoseDestination'); | ||
| 7 | has MatchingEventTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has SNSDestination => (is => 'ro', isa => 'Paws::SES::SNSDestination'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::SES::EventDestination | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::SES::EventDestination object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { CloudWatchDestination => $value, ..., SNSDestination => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::SES::EventDestination object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->CloudWatchDestination | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Contains information about the event destination that the specified | ||
| 42 | email sending events will be published to. | ||
| 43 | |||
| 44 | When you create or update an event destination, you must provide one, | ||
| 45 | and only one, destination. The destination can be Amazon CloudWatch, | ||
| 46 | Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon | ||
| 47 | SNS). | ||
| 48 | |||
| 49 | Event destinations are associated with configuration sets, which enable | ||
| 50 | you to publish email sending events to Amazon CloudWatch, Amazon | ||
| 51 | Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). | ||
| 52 | For information about using configuration sets, see the Amazon SES | ||
| 53 | Developer Guide | ||
| 54 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html). | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 CloudWatchDestination => L<Paws::SES::CloudWatchDestination> | ||
| 60 | |||
| 61 | An object that contains the names, default values, and sources of the | ||
| 62 | dimensions associated with an Amazon CloudWatch event destination. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Enabled => Bool | ||
| 66 | |||
| 67 | Sets whether Amazon SES publishes events to this destination when you | ||
| 68 | send an email with the associated configuration set. Set to C<true> to | ||
| 69 | enable publishing to this destination; set to C<false> to prevent | ||
| 70 | publishing to this destination. The default value is C<false>. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 KinesisFirehoseDestination => L<Paws::SES::KinesisFirehoseDestination> | ||
| 74 | |||
| 75 | An object that contains the delivery stream ARN and the IAM role ARN | ||
| 76 | associated with an Amazon Kinesis Firehose event destination. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> MatchingEventTypes => ArrayRef[Str|Undef] | ||
| 80 | |||
| 81 | The type of email sending events to publish to the event destination. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Name => Str | ||
| 85 | |||
| 86 | The name of the event destination. The name must: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), | ||
| 93 | underscores (_), or dashes (-). | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Contain less than 64 characters. | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 SNSDestination => L<Paws::SES::SNSDestination> | ||
| 104 | |||
| 105 | An object that contains the topic ARN associated with an Amazon Simple | ||
| 106 | Notification Service (Amazon SNS) event destination. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, describing an object used in L<Paws::SES> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |