class Aws::DocDB::Types::CreateEventSubscriptionMessage

Represents the input to CreateEventSubscription.

@note When making an API call, you may pass CreateEventSubscriptionMessage

data as a 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",
        },
      ],
    }

@!attribute [rw] subscription_name

The name of the subscription.

Constraints: The name must be fewer than 255 characters.
@return [String]

@!attribute [rw] sns_topic_arn

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.
@return [String]

@!attribute [rw] source_type

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`
@return [String]

@!attribute [rw] event_categories

A list of event categories for a `SourceType` that you want to
subscribe to.
@return [Array<String>]

@!attribute [rw] source_ids

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.
@return [Array<String>]

@!attribute [rw] enabled

A Boolean value; set to `true` to activate the subscription, set to
`false` to create the subscription but not active it.
@return [Boolean]

@!attribute [rw] tags

The tags to be assigned to the event subscription.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateEventSubscriptionMessage AWS API Documentation

Constants

SENSITIVE