configuration_set_event_destinations

Creates, updates, deletes, gets or lists a configuration_set_event_destinations resource.

Overview

Name	configuration_set_event_destinations
Type	Resource
Id	aws.pinpoint_sms_voice.configuration_set_event_destinations

Fields

The following fields are returned by SELECT queries:

get_configuration_set_event_destinations

Name	Datatype	Description
event_destinations	array	An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration_set_event_destinations	select	configuration_set_name, region		Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
create_configuration_set_event_destination	insert	configuration_set_name, region		Create a new event destination in a configuration set.
update_configuration_set_event_destination	update	configuration_set_name, event_destination_name, region		Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.
delete_configuration_set_event_destination	delete	configuration_set_name, event_destination_name, region		Deletes an event destination in a configuration set.

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

SELECT examples

get_configuration_set_event_destinations

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

SELECT
event_destinations
FROM aws.pinpoint_sms_voice.configuration_set_event_destinations
WHERE configuration_set_name = '{{ configuration_set_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_configuration_set_event_destination

Create a new event destination in a configuration set.

INSERT INTO aws.pinpoint_sms_voice.configuration_set_event_destinations (
EventDestination,
EventDestinationName,
configuration_set_name,
region
)
SELECT 
'{{ EventDestination }}',
'{{ EventDestinationName }}',
'{{ configuration_set_name }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: configuration_set_event_destinations
props:
  - name: configuration_set_name
    value: "{{ configuration_set_name }}"
    description: Required parameter for the configuration_set_event_destinations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_set_event_destinations resource.
  - name: EventDestination
    description: |
      An object that defines a single event destination.
    value:
      CloudWatchLogsDestination:
        IamRoleArn: "{{ IamRoleArn }}"
        LogGroupArn: "{{ LogGroupArn }}"
      Enabled: {{ Enabled }}
      KinesisFirehoseDestination:
        DeliveryStreamArn: "{{ DeliveryStreamArn }}"
        IamRoleArn: "{{ IamRoleArn }}"
      MatchingEventTypes:
        - "{{ MatchingEventTypes }}"
      SnsDestination:
        TopicArn: "{{ TopicArn }}"
  - name: EventDestinationName
    value: "{{ EventDestinationName }}"

UPDATE examples

update_configuration_set_event_destination

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.

UPDATE aws.pinpoint_sms_voice.configuration_set_event_destinations
SET 
EventDestination = '{{ EventDestination }}'
WHERE 
configuration_set_name = '{{ configuration_set_name }}' --required
AND event_destination_name = '{{ event_destination_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_configuration_set_event_destination

Deletes an event destination in a configuration set.

DELETE FROM aws.pinpoint_sms_voice.configuration_set_event_destinations
WHERE configuration_set_name = '{{ configuration_set_name }}' --required
AND event_destination_name = '{{ event_destination_name }}' --required
AND region = '{{ region }}' --required
;