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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

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)


975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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

#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>)


975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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

#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)


975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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

#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>)


975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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

#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 isn't specified, all events are returned.

Valid values: replication-instance | replication-task

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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

#subscription_nameString

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

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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

#tagsArray<Types::Tag>

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

Returns:



975
976
977
978
979
980
981
982
983
984
985
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 975

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