You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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

Returns:

  • (Boolean)


9429
9430
9431
9432
9433
9434
9435
9436
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9429

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

#event_categoriesArray<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.

Returns:

  • (Array<String>)


9429
9430
9431
9432
9433
9434
9435
9436
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9429

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

#sns_topic_arnString

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)


9429
9430
9431
9432
9433
9434
9435
9436
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9429

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

#source_typeString

The type of source that will be 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)


9429
9430
9431
9432
9433
9434
9435
9436
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9429

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

#subscription_nameString

The name of the RDS event notification subscription.

Returns:

  • (String)


9429
9430
9431
9432
9433
9434
9435
9436
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9429

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