Class: Aws::RDS::Types::ModifyEventSubscriptionMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::ModifyEventSubscriptionMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/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,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #enabled ⇒ Boolean

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

• #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_type ⇒ String

  The type of source that is generating the events.

• #subscription_name ⇒ String

  The name of the RDS event notification subscription.

Instance Attribute Details

#enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10974

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

#event_categories ⇒ Array<String>

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the [Events] topic in the *Amazon RDS User Guide* or by using the DescribeEventCategories action.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 10974

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

# File 'lib/aws-sdk-rds/types.rb', line 10974

class ModifyEventSubscriptionMessage < Struct.new(
  :subscription_name,
  :sns_topic_arn,
  :source_type,
  :event_categories,
  :enabled)
  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 a DB instance, you would 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 | db-snapshot

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 10974

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

#subscription_name ⇒ String

The name of the RDS event notification subscription.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 10974

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