/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::CreateEventSubscription

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method CreateEventSubscription on the Amazon Relational Database Service 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('RDS');
# To create an event notification subscription
# This example creates an event notification subscription.
my $CreateEventSubscriptionResult = $rds->CreateEventSubscription(
  'Enabled'          => 1,
  'EventCategories'  => ['availability'],
  'SnsTopicArn'      => 'arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic',
  'SourceIds'        => ['mymysqlinstance'],
  'SourceType'       => 'db-instance',
  'SubscriptionName' => 'mymysqleventsubscription'
);

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

# Returns a L<Paws::RDS::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 value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

EventCategories => ArrayRef[Str|Undef]

A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

REQUIRED SnsTopicArn => Str

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS 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 supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

SourceType => Str

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

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

REQUIRED SubscriptionName => Str

The name of the subscription.

Constraints: The name must be less than 255 characters.

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

SEE ALSO

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

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