« blib/lib/Paws/RedShift/ModifyEndpointAccess.pm
↑ Summary
blib/lib/Paws/RedShift/ModifyEventSubscriptionResult.pm »
| 1 | |||
| 2 | package Paws::RedShift::ModifyEventSubscription; | ||
| 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'); | ||
| 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 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyEventSubscription'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ModifyEventSubscriptionResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyEventSubscriptionResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::RedShift::ModifyEventSubscription - Arguments for method ModifyEventSubscription on L<Paws::RedShift> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ModifyEventSubscription on the | ||
| 28 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 29 | as arguments to method ModifyEventSubscription. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyEventSubscription. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $redshift = Paws->service('RedShift'); | ||
| 36 | my $ModifyEventSubscriptionResult = $redshift->ModifyEventSubscription( | ||
| 37 | SubscriptionName => 'MyString', | ||
| 38 | Enabled => 1, # OPTIONAL | ||
| 39 | EventCategories => [ | ||
| 40 | 'MyString', ... # max: 2147483647 | ||
| 41 | ], # OPTIONAL | ||
| 42 | Severity => 'MyString', # OPTIONAL | ||
| 43 | SnsTopicArn => 'MyString', # OPTIONAL | ||
| 44 | SourceIds => [ | ||
| 45 | 'MyString', ... # max: 2147483647 | ||
| 46 | ], # OPTIONAL | ||
| 47 | SourceType => 'MyString', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $EventSubscription = $ModifyEventSubscriptionResult->EventSubscription; | ||
| 52 | |||
| 53 | # Returns a L<Paws::RedShift::ModifyEventSubscriptionResult> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/ModifyEventSubscription> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Enabled => Bool | ||
| 62 | |||
| 63 | A Boolean value indicating if the subscription is enabled. C<true> | ||
| 64 | indicates the subscription is enabled | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 EventCategories => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | Specifies the Amazon Redshift event categories to be published by the | ||
| 71 | event notification subscription. | ||
| 72 | |||
| 73 | Values: configuration, management, monitoring, security | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 Severity => Str | ||
| 78 | |||
| 79 | Specifies the Amazon Redshift event severity to be published by the | ||
| 80 | event notification subscription. | ||
| 81 | |||
| 82 | Values: ERROR, INFO | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 SnsTopicArn => Str | ||
| 87 | |||
| 88 | The Amazon Resource Name (ARN) of the SNS topic to be used by the event | ||
| 89 | notification subscription. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 SourceIds => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | A list of one or more identifiers of Amazon Redshift source objects. | ||
| 96 | All of the objects must be of the same type as was specified in the | ||
| 97 | source type parameter. The event subscription will return only events | ||
| 98 | generated by the specified objects. If not specified, then events are | ||
| 99 | returned for all objects within the source type specified. | ||
| 100 | |||
| 101 | Example: my-cluster-1, my-cluster-2 | ||
| 102 | |||
| 103 | Example: my-snapshot-20131010 | ||
| 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 cluster, you would set | ||
| 111 | this parameter to cluster. If this value is not specified, events are | ||
| 112 | returned for all Amazon Redshift objects in your AWS account. You must | ||
| 113 | specify a source type in order to specify source IDs. | ||
| 114 | |||
| 115 | Valid values: cluster, cluster-parameter-group, cluster-security-group, | ||
| 116 | cluster-snapshot, and scheduled-action. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> SubscriptionName => Str | ||
| 121 | |||
| 122 | The name of the modified Amazon Redshift event notification | ||
| 123 | subscription. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method ModifyEventSubscription in L<Paws::RedShift> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |