blib/lib/Paws/Neptune/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::Neptune::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::Neptune::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::Neptune::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::Neptune::CreateEventSubscription - Arguments for method CreateEventSubscription on L<Paws::Neptune>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method CreateEventSubscription on the
28 L<Amazon Neptune|Paws::Neptune> 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('Neptune');
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::Neptune::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 B<true> to activate the subscription, set to
66 B<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 SourceType that you want to subscribe
73 to. You can see a list of the categories for a given SourceType by
74 using the B<DescribeEventCategories> action.
75  
76  
77  
78 =head2 B<REQUIRED> SnsTopicArn => Str
79  
80 The Amazon Resource Name (ARN) of the SNS topic created for event
81 notification. The ARN is created by Amazon SNS when you create a topic
82 and subscribe to it.
83  
84  
85  
86 =head2 SourceIds => ArrayRef[Str|Undef]
87  
88 The list of identifiers of the event sources for which events are
89 returned. If not specified, then all sources are included in the
90 response. An identifier must begin with a letter and must contain only
91 ASCII letters, digits, and hyphens; it can't end with a hyphen or
92 contain two consecutive hyphens.
93  
94 Constraints:
95  
96 =over
97  
98 =item *
99  
100 If SourceIds are supplied, SourceType must also be provided.
101  
102 =item *
103  
104 If the source type is a DB instance, then a C<DBInstanceIdentifier>
105 must be supplied.
106  
107 =item *
108  
109 If the source type is a DB security group, a C<DBSecurityGroupName>
110 must be supplied.
111  
112 =item *
113  
114 If the source type is a DB parameter group, a C<DBParameterGroupName>
115 must be supplied.
116  
117 =item *
118  
119 If the source type is a DB snapshot, a C<DBSnapshotIdentifier> must be
120 supplied.
121  
122 =back
123  
124  
125  
126  
127 =head2 SourceType => Str
128  
129 The type of source that is generating the events. For example, if you
130 want to be notified of events generated by a DB instance, you would set
131 this parameter to db-instance. if this value is not specified, all
132 events are returned.
133  
134 Valid values: C<db-instance> | C<db-cluster> | C<db-parameter-group> |
135 C<db-security-group> | C<db-snapshot> | C<db-cluster-snapshot>
136  
137  
138  
139 =head2 B<REQUIRED> SubscriptionName => Str
140  
141 The name of the subscription.
142  
143 Constraints: The name must be less than 255 characters.
144  
145  
146  
147 =head2 Tags => ArrayRef[L<Paws::Neptune::Tag>]
148  
149 The tags to be applied to the new event subscription.
150  
151  
152  
153  
154 =head1 SEE ALSO
155  
156 This class forms part of L<Paws>, documenting arguments for method CreateEventSubscription in L<Paws::Neptune>
157  
158 =head1 BUGS and CONTRIBUTIONS
159  
160 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
161  
162 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
163  
164 =cut
165