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

Class: Aws::DatabaseMigrationService::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",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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

Returns:

  • (Boolean)

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

#event_categoriesArray<String>

A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the AWS Database Migration Service User Guide.

Returns:

  • (Array<String>)

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

#sns_topic_arnString

The Amazon Resource Name (ARN) of the Amazon 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 Amazon SNS topic created for event notification.

#source_idsArray<String>

A list of identifiers for which AWS DMS provides notification events.

If you don\'t specify a value, notifications are provided for all sources.

If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.

Returns:

  • (Array<String>)

    A list of identifiers for which AWS DMS provides notification events.

#source_typeString

The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.

Valid values: replication-instance | replication-task

Returns:

  • (String)

    The type of AWS DMS resource that generates the events.

#subscription_nameString

The name of the AWS DMS event notification subscription. This name must be less than 255 characters.

Returns:

  • (String)

    The name of the AWS DMS event notification subscription.

#tagsArray<Types::Tag>

One or more tags to be assigned to the event subscription.

Returns:

  • (Array<Types::Tag>)

    One or more tags to be assigned to the event subscription.