File Coverage

blib/lib/Paws/RedShift/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::RedShift::CreateEventSubscription;
3 1     1   284 use Moose;
  1         3  
  1         7  
4             has Enabled => (is => 'ro', isa => 'Bool');
5             has EventCategories => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has Severity => (is => 'ro', isa => 'Str');
7             has SnsTopicArn => (is => 'ro', isa => 'Str', required => 1);
8             has SourceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9             has SourceType => (is => 'ro', isa => 'Str');
10             has SubscriptionName => (is => 'ro', isa => 'Str', required => 1);
11             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]');
12              
13 1     1   5623 use MooseX::ClassAttribute;
  1         3  
  1         6  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEventSubscription');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::CreateEventSubscriptionResult');
17             class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateEventSubscriptionResult');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::RedShift::CreateEventSubscription - Arguments for method CreateEventSubscription on Paws::RedShift
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method CreateEventSubscription on the
29             Amazon Redshift service. Use the attributes of this class
30             as arguments to method CreateEventSubscription.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEventSubscription.
33              
34             As an example:
35              
36             $service_obj->CreateEventSubscription(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 Enabled => Bool
44              
45             A Boolean value; set to C<true> to activate the subscription, set to
46             C<false> to create the subscription but not active it.
47              
48              
49              
50             =head2 EventCategories => ArrayRef[Str|Undef]
51              
52             Specifies the Amazon Redshift event categories to be published by the
53             event notification subscription.
54              
55             Values: Configuration, Management, Monitoring, Security
56              
57              
58              
59             =head2 Severity => Str
60              
61             Specifies the Amazon Redshift event severity to be published by the
62             event notification subscription.
63              
64             Values: ERROR, INFO
65              
66              
67              
68             =head2 B<REQUIRED> SnsTopicArn => Str
69              
70             The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit
71             the event notifications. The ARN is created by Amazon SNS when you
72             create a topic and subscribe to it.
73              
74              
75              
76             =head2 SourceIds => ArrayRef[Str|Undef]
77              
78             A list of one or more identifiers of Amazon Redshift source objects.
79             All of the objects must be of the same type as was specified in the
80             source type parameter. The event subscription will return only events
81             generated by the specified objects. If not specified, then events are
82             returned for all objects within the source type specified.
83              
84             Example: my-cluster-1, my-cluster-2
85              
86             Example: my-snapshot-20131010
87              
88              
89              
90             =head2 SourceType => Str
91              
92             The type of source that will be generating the events. For example, if
93             you want to be notified of events generated by a cluster, you would set
94             this parameter to cluster. If this value is not specified, events are
95             returned for all Amazon Redshift objects in your AWS account. You must
96             specify a source type in order to specify source IDs.
97              
98             Valid values: cluster, cluster-parameter-group, cluster-security-group,
99             and cluster-snapshot.
100              
101              
102              
103             =head2 B<REQUIRED> SubscriptionName => Str
104              
105             The name of the event subscription to be created.
106              
107             Constraints:
108              
109             =over
110              
111             =item *
112              
113             Cannot be null, empty, or blank.
114              
115             =item *
116              
117             Must contain from 1 to 255 alphanumeric characters or hyphens.
118              
119             =item *
120              
121             First character must be a letter.
122              
123             =item *
124              
125             Cannot end with a hyphen or contain two consecutive hyphens.
126              
127             =back
128              
129              
130              
131              
132             =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>]
133              
134             A list of tag instances.
135              
136              
137              
138              
139             =head1 SEE ALSO
140              
141             This class forms part of L<Paws>, documenting arguments for method CreateEventSubscription in L<Paws::RedShift>
142              
143             =head1 BUGS and CONTRIBUTIONS
144              
145             The source code is located here: https://github.com/pplu/aws-sdk-perl
146              
147             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
148              
149             =cut
150