NAME

Paws::DocDB::CreateEventSubscription - Arguments for method CreateEventSubscription on Paws::DocDB

DESCRIPTION

This class represents the parameters used for calling the method CreateEventSubscription on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method CreateEventSubscription.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEventSubscription.

SYNOPSIS

my $rds = Paws->service('DocDB');
my $CreateEventSubscriptionResult = $rds->CreateEventSubscription(
  SnsTopicArn      => 'MyString',
  SubscriptionName => 'MyString',
  Enabled          => 1,                      # OPTIONAL
  EventCategories  => [ 'MyString', ... ],    # OPTIONAL
  SourceIds        => [ 'MyString', ... ],    # OPTIONAL
  SourceType       => 'MyString',             # OPTIONAL
  Tags             => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                          # OPTIONAL
);

# Results:
my $EventSubscription = $CreateEventSubscriptionResult->EventSubscription;

# Returns a L<Paws::DocDB::CreateEventSubscriptionResult> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/CreateEventSubscription

ATTRIBUTES

Enabled => Bool

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

EventCategories => ArrayRef[Str|Undef]

A list of event categories for a SourceType that you want to subscribe to.

REQUIRED SnsTopicArn => Str

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

SourceIds => ArrayRef[Str|Undef]

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

SourceType => Str

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

REQUIRED SubscriptionName => Str

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

Tags => ArrayRef[Paws::DocDB::Tag]

The tags to be assigned to the event subscription.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateEventSubscription in Paws::DocDB

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws