Class: Aws::DatabaseMigrationService::Types::CreateEventSubscriptionMessage

Inherits:

Struct

• Object
• Struct
• Aws::DatabaseMigrationService::Types::CreateEventSubscriptionMessage

Includes:

Structure

Defined in:

lib/aws-sdk-databasemigrationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

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

• #event_categories ⇒ Array<String>

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

• #sns_topic_arn ⇒ String

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

• #source_ids ⇒ Array<String>

  A list of identifiers for which DMS provides notification events.

• #source_type ⇒ String

  The type of DMS resource that generates the events.

• #subscription_name ⇒ String

  The name of the DMS event notification subscription.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#event_categories ⇒ Array<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 *Database Migration Service User Guide.*

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

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)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_ids ⇒ Array<String>

A list of identifiers for which 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>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_type ⇒ String

The type of 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 isn’t specified, all events are returned.

Valid values: ‘replication-instance` | `replication-task`

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1122

class CreateEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :source_ids,
  :enabled,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end