« blib/lib/Paws/RedShift/CreateEndpointAccess.pm
↑ Summary
blib/lib/Paws/RedShift/CreateEventSubscriptionResult.pm »
| 1 | |||
| 2 | package Paws::RedShift::CreateEventSubscription; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::RedShift> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateEventSubscription on the | ||
| 29 | L<Amazon Redshift|Paws::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 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $redshift = Paws->service('RedShift'); | ||
| 37 | my $CreateEventSubscriptionResult = $redshift->CreateEventSubscription( | ||
| 38 | SnsTopicArn => 'MyString', | ||
| 39 | SubscriptionName => 'MyString', | ||
| 40 | Enabled => 1, # OPTIONAL | ||
| 41 | EventCategories => [ | ||
| 42 | 'MyString', ... # max: 2147483647 | ||
| 43 | ], # OPTIONAL | ||
| 44 | Severity => 'MyString', # OPTIONAL | ||
| 45 | SourceIds => [ | ||
| 46 | 'MyString', ... # max: 2147483647 | ||
| 47 | ], # OPTIONAL | ||
| 48 | SourceType => 'MyString', # OPTIONAL | ||
| 49 | Tags => [ | ||
| 50 | { | ||
| 51 | Key => 'MyString', # max: 2147483647 | ||
| 52 | Value => 'MyString', # max: 2147483647 | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $EventSubscription = $CreateEventSubscriptionResult->EventSubscription; | ||
| 60 | |||
| 61 | # Returns a L<Paws::RedShift::CreateEventSubscriptionResult> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/CreateEventSubscription> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Enabled => Bool | ||
| 70 | |||
| 71 | A boolean value; set to C<true> to activate the subscription, and set | ||
| 72 | to C<false> to create the subscription but not activate it. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 EventCategories => ArrayRef[Str|Undef] | ||
| 77 | |||
| 78 | Specifies the Amazon Redshift event categories to be published by the | ||
| 79 | event notification subscription. | ||
| 80 | |||
| 81 | Values: configuration, management, monitoring, security | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 Severity => Str | ||
| 86 | |||
| 87 | Specifies the Amazon Redshift event severity to be published by the | ||
| 88 | event notification subscription. | ||
| 89 | |||
| 90 | Values: ERROR, INFO | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> SnsTopicArn => Str | ||
| 95 | |||
| 96 | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit | ||
| 97 | the event notifications. The ARN is created by Amazon SNS when you | ||
| 98 | create a topic and subscribe to it. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 SourceIds => ArrayRef[Str|Undef] | ||
| 103 | |||
| 104 | A list of one or more identifiers of Amazon Redshift source objects. | ||
| 105 | All of the objects must be of the same type as was specified in the | ||
| 106 | source type parameter. The event subscription will return only events | ||
| 107 | generated by the specified objects. If not specified, then events are | ||
| 108 | returned for all objects within the source type specified. | ||
| 109 | |||
| 110 | Example: my-cluster-1, my-cluster-2 | ||
| 111 | |||
| 112 | Example: my-snapshot-20131010 | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 SourceType => Str | ||
| 117 | |||
| 118 | The type of source that will be generating the events. For example, if | ||
| 119 | you want to be notified of events generated by a cluster, you would set | ||
| 120 | this parameter to cluster. If this value is not specified, events are | ||
| 121 | returned for all Amazon Redshift objects in your AWS account. You must | ||
| 122 | specify a source type in order to specify source IDs. | ||
| 123 | |||
| 124 | Valid values: cluster, cluster-parameter-group, cluster-security-group, | ||
| 125 | cluster-snapshot, and scheduled-action. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> SubscriptionName => Str | ||
| 130 | |||
| 131 | The name of the event subscription to be created. | ||
| 132 | |||
| 133 | Constraints: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | Cannot be null, empty, or blank. | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | Must contain from 1 to 255 alphanumeric characters or hyphens. | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | First character must be a letter. | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 152 | |||
| 153 | =back | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>] | ||
| 159 | |||
| 160 | A list of tag instances. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head1 SEE ALSO | ||
| 166 | |||
| 167 | This class forms part of L<Paws>, documenting arguments for method CreateEventSubscription in L<Paws::RedShift> | ||
| 168 | |||
| 169 | =head1 BUGS and CONTRIBUTIONS | ||
| 170 | |||
| 171 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 172 | |||
| 173 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 174 | |||
| 175 | =cut | ||
| 176 |