« blib/lib/Paws/DMS/CreateEndpointResponse.pm
↑ Summary
blib/lib/Paws/DMS/CreateEventSubscriptionResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::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::DMS::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::DMS::CreateEventSubscriptionResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::DMS::CreateEventSubscription - Arguments for method CreateEventSubscription on L<Paws::DMS> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateEventSubscription on the | ||
| 28 | L<AWS Database Migration Service|Paws::DMS> 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 $dms = Paws->service('DMS'); | ||
| 36 | my $CreateEventSubscriptionResponse = $dms->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 = $CreateEventSubscriptionResponse->EventSubscription; | ||
| 54 | |||
| 55 | # Returns a L<Paws::DMS::CreateEventSubscriptionResponse> 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/dms/CreateEventSubscription> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Enabled => Bool | ||
| 64 | |||
| 65 | A Boolean value; set to C<true> to activate the subscription, or set to | ||
| 66 | C<false> to create the subscription but not activate it. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 EventCategories => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | A list of event categories for a source type that you want to subscribe | ||
| 73 | to. For more information, see Working with Events and Notifications | ||
| 74 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in | ||
| 75 | the I<AWS Database Migration Service User Guide.> | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> SnsTopicArn => Str | ||
| 80 | |||
| 81 | The Amazon Resource Name (ARN) of the Amazon SNS topic created for | ||
| 82 | event notification. The ARN is created by Amazon SNS when you create a | ||
| 83 | topic and subscribe to it. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 SourceIds => ArrayRef[Str|Undef] | ||
| 88 | |||
| 89 | A list of identifiers for which AWS DMS provides notification events. | ||
| 90 | |||
| 91 | If you don't specify a value, notifications are provided for all | ||
| 92 | sources. | ||
| 93 | |||
| 94 | If you specify multiple values, they must be of the same type. For | ||
| 95 | example, if you specify a database instance ID, then all of the other | ||
| 96 | values must be database instance IDs. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 SourceType => Str | ||
| 101 | |||
| 102 | The type of AWS DMS resource that generates the events. For example, if | ||
| 103 | you want to be notified of events generated by a replication instance, | ||
| 104 | you set this parameter to C<replication-instance>. If this value isn't | ||
| 105 | specified, all events are returned. | ||
| 106 | |||
| 107 | Valid values: C<replication-instance> | C<replication-task> | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> SubscriptionName => Str | ||
| 112 | |||
| 113 | The name of the AWS DMS event notification subscription. This name must | ||
| 114 | be less than 255 characters. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 Tags => ArrayRef[L<Paws::DMS::Tag>] | ||
| 119 | |||
| 120 | One or more tags to be assigned to the event subscription. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, documenting arguments for method CreateEventSubscription in L<Paws::DMS> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |