blib/lib/Paws/DocDB/CreateEventSubscription.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DocDB::CreateEventSubscription;
3 use Moose;
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::DocDB::Tag]');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEventSubscription');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::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::DocDB::CreateEventSubscription - Arguments for method CreateEventSubscription on L<Paws::DocDB>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method CreateEventSubscription on the
28 L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> 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 =head1 SYNOPSIS
34  
35 my $rds = Paws->service('DocDB');
36 my $CreateEventSubscriptionResult = $rds->CreateEventSubscription(
37 SnsTopicArn => 'MyString',
38 SubscriptionName => 'MyString',
39 Enabled => 1, # OPTIONAL
40 EventCategories => [ 'MyString', ... ], # OPTIONAL
41 SourceIds => [ 'MyString', ... ], # OPTIONAL
42 SourceType => 'MyString', # OPTIONAL
43 Tags => [
44 {
45 Key => 'MyString',
46 Value => 'MyString',
47 },
48 ...
49 ], # OPTIONAL
50 );
51  
52 # Results:
53 my $EventSubscription = $CreateEventSubscriptionResult->EventSubscription;
54  
55 # Returns a L<Paws::DocDB::CreateEventSubscriptionResult> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateEventSubscription>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 Enabled => Bool
64  
65 A Boolean value; set to C<true> to activate the subscription, set to
66 C<false> to create the subscription but not active it.
67  
68  
69  
70 =head2 EventCategories => ArrayRef[Str|Undef]
71  
72 A list of event categories for a C<SourceType> that you want to
73 subscribe to.
74  
75  
76  
77 =head2 B<REQUIRED> SnsTopicArn => Str
78  
79 The Amazon Resource Name (ARN) of the SNS topic created for event
80 notification. Amazon SNS creates the ARN when you create a topic and
81 subscribe to it.
82  
83  
84  
85 =head2 SourceIds => ArrayRef[Str|Undef]
86  
87 The list of identifiers of the event sources for which events are
88 returned. If not specified, then all sources are included in the
89 response. An identifier must begin with a letter and must contain only
90 ASCII letters, digits, and hyphens; it can't end with a hyphen or
91 contain two consecutive hyphens.
92  
93 Constraints:
94  
95 =over
96  
97 =item *
98  
99 If C<SourceIds> are provided, C<SourceType> must also be provided.
100  
101 =item *
102  
103 If the source type is an instance, a C<DBInstanceIdentifier> must be
104 provided.
105  
106 =item *
107  
108 If the source type is a security group, a C<DBSecurityGroupName> must
109 be provided.
110  
111 =item *
112  
113 If the source type is a parameter group, a C<DBParameterGroupName> must
114 be provided.
115  
116 =item *
117  
118 If the source type is a snapshot, a C<DBSnapshotIdentifier> must be
119 provided.
120  
121 =back
122  
123  
124  
125  
126 =head2 SourceType => Str
127  
128 The type of source that is generating the events. For example, if you
129 want to be notified of events generated by an instance, you would set
130 this parameter to C<db-instance>. If this value is not specified, all
131 events are returned.
132  
133 Valid values: C<db-instance>, C<db-cluster>, C<db-parameter-group>,
134 C<db-security-group>, C<db-cluster-snapshot>
135  
136  
137  
138 =head2 B<REQUIRED> SubscriptionName => Str
139  
140 The name of the subscription.
141  
142 Constraints: The name must be fewer than 255 characters.
143  
144  
145  
146 =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>]
147  
148 The tags to be assigned to the event subscription.
149  
150  
151  
152  
153 =head1 SEE ALSO
154  
155 This class forms part of L<Paws>, documenting arguments for method CreateEventSubscription in L<Paws::DocDB>
156  
157 =head1 BUGS and CONTRIBUTIONS
158  
159 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
160  
161 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
162  
163 =cut
164