File Coverage

blib/lib/Paws/RDS/CreateEventSubscription.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::CreateEventSubscription;
3 1     1   454 use Moose;
  1         3  
  1         9  
4             has Enabled => (is => 'ro', isa => 'Bool');
5             has EventCategories => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has SnsTopicArn => (is => 'ro', isa => 'Str', required => 1);
7             has SourceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has SourceType => (is => 'ro', isa => 'Str');
9             has SubscriptionName => (is => 'ro', isa => 'Str', required => 1);
10             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
11              
12 1     1   6105 use MooseX::ClassAttribute;
  1         4  
  1         9  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEventSubscription');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateEventSubscriptionResult');
16             class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateEventSubscriptionResult');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::RDS::CreateEventSubscription - Arguments for method CreateEventSubscription on Paws::RDS
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method CreateEventSubscription on the
28             Amazon Relational Database Service service. Use the attributes of this class
29             as arguments to method CreateEventSubscription.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEventSubscription.
32              
33             As an example:
34              
35             $service_obj->CreateEventSubscription(Att1 => $value1, Att2 => $value2, ...);
36              
37             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 Enabled => Bool
43              
44             A Boolean value; set to B<true> to activate the subscription, set to
45             B<false> to create the subscription but not active it.
46              
47              
48              
49             =head2 EventCategories => ArrayRef[Str|Undef]
50              
51             A list of event categories for a SourceType that you want to subscribe
52             to. You can see a list of the categories for a given SourceType in the
53             Events topic in the Amazon RDS User Guide or by using the
54             B<DescribeEventCategories> action.
55              
56              
57              
58             =head2 B<REQUIRED> SnsTopicArn => Str
59              
60             The Amazon Resource Name (ARN) of the SNS topic created for event
61             notification. The ARN is created by Amazon SNS when you create a topic
62             and subscribe to it.
63              
64              
65              
66             =head2 SourceIds => ArrayRef[Str|Undef]
67              
68             The list of identifiers of the event sources for which events will be
69             returned. If not specified, then all sources are included in the
70             response. An identifier must begin with a letter and must contain only
71             ASCII letters, digits, and hyphens; it cannot end with a hyphen or
72             contain two consecutive hyphens.
73              
74             Constraints:
75              
76             =over
77              
78             =item *
79              
80             If SourceIds are supplied, SourceType must also be provided.
81              
82             =item *
83              
84             If the source type is a DB instance, then a C<DBInstanceIdentifier>
85             must be supplied.
86              
87             =item *
88              
89             If the source type is a DB security group, a C<DBSecurityGroupName>
90             must be supplied.
91              
92             =item *
93              
94             If the source type is a DB parameter group, a C<DBParameterGroupName>
95             must be supplied.
96              
97             =item *
98              
99             If the source type is a DB snapshot, a C<DBSnapshotIdentifier> must be
100             supplied.
101              
102             =back
103              
104              
105              
106              
107             =head2 SourceType => Str
108              
109             The type of source that will be generating the events. For example, if
110             you want to be notified of events generated by a DB instance, you would
111             set this parameter to db-instance. if this value is not specified, all
112             events are returned.
113              
114             Valid values: C<db-instance> | C<db-cluster> | C<db-parameter-group> |
115             C<db-security-group> | C<db-snapshot> | C<db-cluster-snapshot>
116              
117              
118              
119             =head2 B<REQUIRED> SubscriptionName => Str
120              
121             The name of the subscription.
122              
123             Constraints: The name must be less than 255 characters.
124              
125              
126              
127             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
128              
129              
130              
131              
132              
133              
134             =head1 SEE ALSO
135              
136             This class forms part of L<Paws>, documenting arguments for method CreateEventSubscription in L<Paws::RDS>
137              
138             =head1 BUGS and CONTRIBUTIONS
139              
140             The source code is located here: https://github.com/pplu/aws-sdk-perl
141              
142             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
143              
144             =cut
145