event_topics

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

Overview

Name	event_topics
Type	Resource
Id	aws.ds.event_topics

Fields

The following fields are returned by SELECT queries:

describe_event_topics

Name	Datatype	Description
event_topics	array	A list of Amazon SNS topic names that receive status messages from the specified Directory ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_event_topics	select	region		Obtains information about which Amazon SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
register_event_topic	insert	region, DirectoryId, TopicName		Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
deregister_event_topic	delete	region		Removes the specified directory as a publisher to the specified Amazon SNS topic.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_event_topics

Obtains information about which Amazon SNS topics receive status messages from the specified directory. If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

SELECT
event_topics
FROM aws.ds.event_topics
WHERE region = '{{ region }}' -- required
;

INSERT examples

register_event_topic

Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

INSERT INTO aws.ds.event_topics (
DirectoryId,
TopicName,
region
)
SELECT 
'{{ DirectoryId }}' /* required */,
'{{ TopicName }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: event_topics
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_topics resource.
  - name: DirectoryId
    value: "{{ DirectoryId }}"
    description: |
      The Directory ID that will publish status messages to the Amazon SNS topic.
  - name: TopicName
    value: "{{ TopicName }}"
    description: |
      The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS topic must be in the same region as the specified Directory ID.

DELETE examples

deregister_event_topic

Removes the specified directory as a publisher to the specified Amazon SNS topic.

DELETE FROM aws.ds.event_topics
WHERE region = '{{ region }}' --required
;