destinations

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

Overview

Name	destinations
Type	Resource
Id	aws.iot_managed_integrations.destinations

Fields

The following fields are returned by SELECT queries:

get_destination

Name	Datatype	Description
created_at	string (date-time)	The timestamp value of when the destination creation requset occurred.
delivery_destination_arn	string	The Amazon Resource Name (ARN) of the customer-managed destination. (pattern: <code>arn:aws:[0-9a-zA-Z]+:[0-9a-zA-Z-]+:[0-9]+:[0-9a-zA-Z]+/[0-9a-zA-Z._-]+</code>)
delivery_destination_type	string	The destination type for the customer-managed destination. (KINESIS)
description	string	The description of the customer-managed destination. (pattern: <code>[0-9A-Za-z_- ]+</code>)
name	string	The name of the customer-managed destination. (pattern: <code>[\p{L}\p{N} ._-]+</code>)
role_arn	string	The Amazon Resource Name (ARN) of the delivery destination role.
tags	object	A set of key/value pairs that are used to manage the customer-managed destination.
updated_at	string (date-time)	The timestamp value of when the destination update requset occurred.

list_destinations

Name	Datatype	Description
delivery_destination_arn	string	The Amazon Resource Name (ARN) of the customer-managed destination. (pattern: <code>arn:aws:[0-9a-zA-Z]+:[0-9a-zA-Z-]+:[0-9]+:[0-9a-zA-Z]+/[0-9a-zA-Z._-]+</code>)
delivery_destination_type	string	The destination type for the customer-managed destination. (KINESIS)
description	string	The description of the customer-managed destination. (pattern: <code>[0-9A-Za-z_- ]+</code>)
name	string	The name of the customer-managed destination. (pattern: <code>[\p{L}\p{N} ._-]+</code>)
role_arn	string	The Amazon Resource Name (ARN) of the delivery destination.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_destination	select	name, region		Gets a destination by name.
list_destinations	select	region	NextToken, MaxResults	List all notification destinations.
create_destination	insert	region, DeliveryDestinationArn, DeliveryDestinationType, RoleArn		Create a notification destination such as Kinesis Data Streams that receive events and notifications from Managed integrations. Managed integrations uses the destination to determine where to deliver notifications.
update_destination	update	name, region		Update a destination specified by name.
delete_destination	delete	name, region		Deletes a notification destination specified by name.

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
name	string	The id of the customer-managed destination.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of results to return at one time.
NextToken	string	A token that can be used to retrieve the next set of results.

SELECT examples

get_destination

Gets a destination by name.

SELECT
created_at,
delivery_destination_arn,
delivery_destination_type,
description,
name,
role_arn,
tags,
updated_at
FROM aws.iot_managed_integrations.destinations
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_destinations

List all notification destinations.

SELECT
delivery_destination_arn,
delivery_destination_type,
description,
name,
role_arn
FROM aws.iot_managed_integrations.destinations
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;

INSERT examples

create_destination

Create a notification destination such as Kinesis Data Streams that receive events and notifications from Managed integrations. Managed integrations uses the destination to determine where to deliver notifications.

INSERT INTO aws.iot_managed_integrations.destinations (
DeliveryDestinationArn,
DeliveryDestinationType,
Name,
RoleArn,
ClientToken,
Description,
Tags,
region
)
SELECT 
'{{ DeliveryDestinationArn }}' /* required */,
'{{ DeliveryDestinationType }}' /* required */,
'{{ Name }}',
'{{ RoleArn }}' /* required */,
'{{ ClientToken }}',
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: destinations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the destinations resource.
  - name: DeliveryDestinationArn
    value: "{{ DeliveryDestinationArn }}"
  - name: DeliveryDestinationType
    value: "{{ DeliveryDestinationType }}"
    valid_values: ['KINESIS']
  - name: Name
    value: "{{ Name }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_destination

Update a destination specified by name.

UPDATE aws.iot_managed_integrations.destinations
SET 
DeliveryDestinationArn = '{{ DeliveryDestinationArn }}',
DeliveryDestinationType = '{{ DeliveryDestinationType }}',
RoleArn = '{{ RoleArn }}',
Description = '{{ Description }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_destination

Deletes a notification destination specified by name.

DELETE FROM aws.iot_managed_integrations.destinations
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;