event_subscriptions

Creates, updates, deletes, gets or lists an event_subscriptions resource.

Overview

Name	`event_subscriptions`
Type	Resource
Id	`aws.docdb.event_subscriptions`

Fields

The following fields are returned by SELECT queries:

describe_event_subscriptions

Name	Datatype	Description
`cust_subscription_id`	`string`	The Amazon DocumentDB event notification subscription ID.
`customer_aws_id`	`string`	The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
`enabled`	`boolean`	A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
`event_categories_list`	`string`	A list of event categories for the Amazon DocumentDB event notification subscription.
`event_subscription_arn`	`string`	The Amazon Resource Name (ARN) for the event subscription.
`sns_topic_arn`	`string`	The topic ARN of the Amazon DocumentDB event notification subscription.
`source_ids_list`	`string`	A list of source IDs for the Amazon DocumentDB event notification subscription.
`source_type`	`string`	The source type for the Amazon DocumentDB event notification subscription.
`status`	`string`	The status of the Amazon DocumentDB event notification subscription. Constraints: Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
`subscription_creation_time`	`string`	The time at which the Amazon DocumentDB event notification subscription was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_event_subscriptions`	`select`	`region`	`SubscriptionName`, `Filters`, `MaxRecords`, `Marker`	Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription.
`create_event_subscription`	`insert`	`SubscriptionName`, `SnsTopicArn`, `region`	`SourceType`, `EventCategories`, `SourceIds`, `Enabled`, `Tags`	Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
`modify_event_subscription`	`update`	`SubscriptionName`, `region`	`SnsTopicArn`, `SourceType`, `EventCategories`, `Enabled`	Modifies an existing Amazon DocumentDB event notification subscription.
`delete_event_subscription`	`delete`	`SubscriptionName`, `region`		Deletes an Amazon DocumentDB event notification subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`SnsTopicArn`	`string`	The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
`SubscriptionName`	`string`	The name of the Amazon DocumentDB event notification subscription that you want to delete.
`region`	`string`	AWS region (default: us-east-1)
`Enabled`	`boolean`	A Boolean value; set to true to activate the subscription.
`EventCategories`	`array`	A list of event categories for a SourceType that you want to subscribe to.
`Filters`	`array`	This parameter is not currently supported.
`Marker`	`string`	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
`MaxRecords`	`integer`	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
`SnsTopicArn`	`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.
`SourceIds`	`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 provided, SourceType must also be provided. If the source type is an instance, a DBInstanceIdentifier must be provided. If the source type is a security group, a DBSecurityGroupName must be provided. If the source type is a parameter group, a DBParameterGroupName must be provided. If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
`SourceType`	`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
`SubscriptionName`	`string`	The name of the Amazon DocumentDB event notification subscription that you want to describe.
`Tags`	`array`	The tags to be assigned to the event subscription.

`SELECT` examples

describe_event_subscriptions

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription.

SELECT
cust_subscription_id,
customer_aws_id,
enabled,
event_categories_list,
event_subscription_arn,
sns_topic_arn,
source_ids_list,
source_type,
status,
subscription_creation_time
FROM aws.docdb.event_subscriptions
WHERE region = '{{ region }}' -- required
AND SubscriptionName = '{{ SubscriptionName }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

`INSERT` examples

create_event_subscription
Manifest

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

INSERT INTO aws.docdb.event_subscriptions (
SubscriptionName,
SnsTopicArn,
region,
SourceType,
EventCategories,
SourceIds,
Enabled,
Tags
)
SELECT 
'{{ SubscriptionName }}',
'{{ SnsTopicArn }}',
'{{ region }}',
'{{ SourceType }}',
'{{ EventCategories }}',
'{{ SourceIds }}',
'{{ Enabled }}',
'{{ Tags }}'
RETURNING
cust_subscription_id,
customer_aws_id,
enabled,
event_categories_list,
event_subscription_arn,
sns_topic_arn,
source_ids_list,
source_type,
status,
subscription_creation_time
;

# Description fields are for documentation purposes
- name: event_subscriptions
props:
  - name: SubscriptionName
    value: "{{ SubscriptionName }}"
    description: Required parameter for the event_subscriptions resource.
  - name: SnsTopicArn
    value: "{{ SnsTopicArn }}"
    description: Required parameter for the event_subscriptions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_subscriptions resource.
  - name: SourceType
    value: "{{ SourceType }}"
    description: The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned. Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
    description: The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned. Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
  - name: EventCategories
    value: "{{ EventCategories }}"
    description: A list of event categories for a SourceType that you want to subscribe to.
    description: A list of event categories for a SourceType that you want to subscribe to.
  - name: SourceIds
    value: "{{ SourceIds }}"
    description: 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 provided, SourceType must also be provided. If the source type is an instance, a DBInstanceIdentifier must be provided. If the source type is a security group, a DBSecurityGroupName must be provided. If the source type is a parameter group, a DBParameterGroupName must be provided. If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
    description: 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 provided, SourceType must also be provided. If the source type is an instance, a DBInstanceIdentifier must be provided. If the source type is a security group, a DBSecurityGroupName must be provided. If the source type is a parameter group, a DBParameterGroupName must be provided. If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
  - name: Enabled
    value: {{ Enabled }}
    description: A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    description: A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  - name: Tags
    value: "{{ Tags }}"
    description: The tags to be assigned to the event subscription.
    description: The tags to be assigned to the event subscription.

`UPDATE` examples

modify_event_subscription

Modifies an existing Amazon DocumentDB event notification subscription.

UPDATE aws.docdb.event_subscriptions
SET 
-- No updatable properties
WHERE 
SubscriptionName = '{{ SubscriptionName }}' --required
AND region = '{{ region }}' --required
AND SnsTopicArn = '{{ SnsTopicArn}}'
AND SourceType = '{{ SourceType}}'
AND EventCategories = '{{ EventCategories}}'
AND Enabled = {{ Enabled}}
RETURNING
cust_subscription_id,
customer_aws_id,
enabled,
event_categories_list,
event_subscription_arn,
sns_topic_arn,
source_ids_list,
source_type,
status,
subscription_creation_time;

`DELETE` examples

delete_event_subscription

Deletes an Amazon DocumentDB event notification subscription.

DELETE FROM aws.docdb.event_subscriptions
WHERE SubscriptionName = '{{ SubscriptionName }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​