event_subscription_tags
Expands all tag keys and values for event_subscriptions
in a region
Overview
Name | event_subscription_tags |
Type | Resource |
Description | The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide*. |
Id | aws.rds.event_subscription_tags |
Fields
Name | Datatype | Description |
---|---|---|
subscription_name | string | The name of the subscription. Constraints: The name must be less than 255 characters. |
enabled | boolean | Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. |
event_categories | array | A list of event categories for a particular source type (SourceType ) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html). You can also see this list by using the DescribeEventCategories operation. |
sns_topic_arn | string | The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. RDS doesn't support FIFO (first in, first out) topics. For more information, see [Message ordering and deduplication (FIFO topics)](https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) in the *Amazon Simple Notification Service Developer Guide*. |
source_ids | array | 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 supplied, SourceType must also be provided.+ If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.+ If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.+ If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.+ If the source type is a DB security group, a DBSecurityGroupName value must be supplied.+ If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.+ If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.+ If the source type is an RDS Proxy, a DBProxyName value must be supplied. |
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 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 | zero-etl | custom-engine-version | blue-green-deployment |
tag_key | string | Tag key. |
tag_value | string | Tag value. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Expands tags for all event_subscriptions
in a region.
SELECT
region,
subscription_name,
enabled,
event_categories,
sns_topic_arn,
source_ids,
source_type,
tag_key,
tag_value
FROM aws.rds.event_subscription_tags
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the event_subscription_tags
resource, see event_subscriptions