« blib/lib/Paws/Neptune/ModifyDBSubnetGroupResult.pm
↑ Summary
blib/lib/Paws/Neptune/ModifyEventSubscriptionResult.pm »
| 1 | |||
| 2 | package Paws::Neptune::ModifyEventSubscription; | ||
| 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'); | ||
| 7 | has SourceType => (is => 'ro', isa => 'Str'); | ||
| 8 | has SubscriptionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyEventSubscription'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::ModifyEventSubscriptionResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyEventSubscriptionResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Neptune::ModifyEventSubscription - Arguments for method ModifyEventSubscription on L<Paws::Neptune> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ModifyEventSubscription on the | ||
| 26 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 27 | as arguments to method ModifyEventSubscription. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyEventSubscription. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('Neptune'); | ||
| 34 | my $ModifyEventSubscriptionResult = $rds->ModifyEventSubscription( | ||
| 35 | SubscriptionName => 'MyString', | ||
| 36 | Enabled => 1, # OPTIONAL | ||
| 37 | EventCategories => [ 'MyString', ... ], # OPTIONAL | ||
| 38 | SnsTopicArn => 'MyString', # OPTIONAL | ||
| 39 | SourceType => 'MyString', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $EventSubscription = $ModifyEventSubscriptionResult->EventSubscription; | ||
| 44 | |||
| 45 | # Returns a L<Paws::Neptune::ModifyEventSubscriptionResult> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyEventSubscription> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Enabled => Bool | ||
| 54 | |||
| 55 | A Boolean value; set to B<true> to activate the subscription. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 EventCategories => ArrayRef[Str|Undef] | ||
| 60 | |||
| 61 | A list of event categories for a SourceType that you want to subscribe | ||
| 62 | to. You can see a list of the categories for a given SourceType by | ||
| 63 | using the B<DescribeEventCategories> action. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 SnsTopicArn => Str | ||
| 68 | |||
| 69 | The Amazon Resource Name (ARN) of the SNS topic created for event | ||
| 70 | notification. The ARN is created by Amazon SNS when you create a topic | ||
| 71 | and subscribe to it. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 SourceType => Str | ||
| 76 | |||
| 77 | The type of source that is generating the events. For example, if you | ||
| 78 | want to be notified of events generated by a DB instance, you would set | ||
| 79 | this parameter to db-instance. if this value is not specified, all | ||
| 80 | events are returned. | ||
| 81 | |||
| 82 | Valid values: db-instance | db-parameter-group | db-security-group | | ||
| 83 | db-snapshot | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> SubscriptionName => Str | ||
| 88 | |||
| 89 | The name of the event notification subscription. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method ModifyEventSubscription in L<Paws::Neptune> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |