Class: Aws::RDS::Types::ModifyEventSubscriptionMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::ModifyEventSubscriptionMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
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,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#enabled ⇒ Boolean
A value that indicates whether to activate the subscription.
-
#event_categories ⇒ Array<String>
A list of event categories for a source type (`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 value that indicates whether to activate the subscription.
16857 16858 16859 16860 16861 16862 16863 16864 16865 |
# File 'lib/aws-sdk-rds/types.rb', line 16857 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 source type (`SourceType`) that you want to subscribe to. You can see a list of the categories for a given source type in [Events] in the *Amazon RDS User Guide* or by using the `DescribeEventCategories` operation.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
16857 16858 16859 16860 16861 16862 16863 16864 16865 |
# File 'lib/aws-sdk-rds/types.rb', line 16857 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.
16857 16858 16859 16860 16861 16862 16863 16864 16865 |
# File 'lib/aws-sdk-rds/types.rb', line 16857 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 a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify `db-proxy`. If this value isn't specified, all events are returned.
Valid values: `db-instance` | `db-cluster` | `db-parameter-group` | `db-security-group` | `db-snapshot` | `db-cluster-snapshot` | `db-proxy`
16857 16858 16859 16860 16861 16862 16863 16864 16865 |
# File 'lib/aws-sdk-rds/types.rb', line 16857 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 RDS event notification subscription.
16857 16858 16859 16860 16861 16862 16863 16864 16865 |
# File 'lib/aws-sdk-rds/types.rb', line 16857 class ModifyEventSubscriptionMessage < Struct.new( :subscription_name, :sns_topic_arn, :source_type, :event_categories, :enabled) SENSITIVE = [] include Aws::Structure end |