Class: Aws::DocDB::Types::ModifyEventSubscriptionMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass ModifyEventSubscriptionMessage data as a hash:

{
  subscription_name: "String", # required
  sns_topic_arn: "String",
  source_type: "String",
  event_categories: ["String"],
  enabled: false,
}

Represents the input to ModifyEventSubscription.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

A Boolean value; set to `true` to activate the subscription.

Returns:

  • (Boolean) 


4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'lib/aws-sdk-docdb/types.rb', line 4965

class ModifyEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :enabled)
  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>) 


4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'lib/aws-sdk-docdb/types.rb', line 4965

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

#sns_topic_arn ⇒ String

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Returns:

  • (String) 


4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'lib/aws-sdk-docdb/types.rb', line 4965

class ModifyEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :enabled)
  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, set this parameter to `db-instance`. If this value is not specified, all events are returned.

Valid values: `db-instance`, `db-parameter-group`, `db-security-group`

Returns:

  • (String) 


4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'lib/aws-sdk-docdb/types.rb', line 4965

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

#subscription_name ⇒ String

The name of the Amazon DocumentDB event notification subscription.

Returns:

  • (String) 


4965
4966
4967
4968
4969
4970
4971
4972
4973
 
# File 'lib/aws-sdk-docdb/types.rb', line 4965

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