Class: Aws::DocDB::Types::CreateEventSubscriptionMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::CreateEventSubscriptionMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/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",
    },
  ],
}

Represents the input to CreateEventSubscription.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

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

• #event_categories ⇒ Array<String>

  A list of event categories for a `SourceType` that you want to subscribe to.

• #sns_topic_arn ⇒ 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.

• #source_type ⇒ String

  The type of source that is generating the events.

• #subscription_name ⇒ String

  The name of the subscription.

• #tags ⇒ Array<Types::Tag>

  The tags to be assigned to the event subscription.

Instance Attribute Details

#enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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 `SourceType` that you want to subscribe to.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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 SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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 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`

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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 subscription.

Constraints: The name must be fewer than 255 characters.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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>

The tags to be assigned to the event subscription.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-docdb/types.rb', line 1231

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