File Coverage

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