You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::CreateEventSubscriptionMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateEventSubscriptionMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  subscription_name: "String", # required
  sns_topic_arn: "String", # required
  source_type: "String",
  event_categories: ["String"],
  source_ids: ["String"],
  enabled: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

A value that indicates whether to activate the subscription. If the event notification subscription isn\'t activated, the subscription is created but not active.

Returns:

  • (Boolean) —

    A value that indicates whether to activate the subscription.

#event_categories ⇒ Array<String>

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 in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Returns:

  • (Array<String>) —

    A list of event categories for a particular source type (SourceType) that you want to subscribe to.

#sns_topic_arn ⇒ String

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.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the SNS topic created for event notification.

#source_ids ⇒ Array<String>

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 a SourceIds value is 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.

Returns:

  • (Array<String>) —

    The list of identifiers of the event sources for which events are returned.

#source_type ⇒ String

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

Returns:

  • (String) —

    The type of source that is generating the events.

#subscription_name ⇒ String

The name of the subscription.

Constraints: The name must be less than 255 characters.

Returns:

  • (String) —

    The name of the subscription.

#tags ⇒ Array<Types::Tag>

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Returns: