topic_rule_destinations

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

Overview

Name	topic_rule_destinations
Type	Resource
Id	aws.iot.topic_rule_destinations

Fields

The following fields are returned by SELECT queries:

get_topic_rule_destination

Name	Datatype	Description
arn	string	The topic rule destination URL.
created_at	string (date-time)	The date and time when the topic rule destination was created.
http_url_properties	object	Properties of the HTTP URL.
last_updated_at	string (date-time)	The date and time when the topic rule destination was last updated.
status	string	The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. (ENABLED, IN_PROGRESS, DISABLED, ERROR, DELETING)
status_reason	string	Additional details or reason why the topic rule destination is in the current status.
vpc_properties	object	Properties of the virtual private cloud (VPC) connection.

list_topic_rule_destinations

Name	Datatype	Description
arn	string	The topic rule destination ARN.
created_at	string (date-time)	The date and time when the topic rule destination was created.
http_url_summary	object	Information about the HTTP URL.
last_updated_at	string (date-time)	The date and time when the topic rule destination was last updated.
status	string	The status of the topic rule destination. Valid values are: IN_PROGRESS A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint. (ENABLED, IN_PROGRESS, DISABLED, ERROR, DELETING)
status_reason	string	The reason the topic rule destination is in the current status.
vpc_destination_summary	object	Information about the virtual private cloud (VPC) connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_topic_rule_destination	select	arn, region		Gets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.
list_topic_rule_destinations	select	region	maxResults, nextToken	Lists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.
create_topic_rule_destination	insert	region, destinationConfiguration		Creates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.
update_topic_rule_destination	update	region, arn, status		Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.
delete_topic_rule_destination	delete	arn, region		Deletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.

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
arn	string	The ARN of the topic rule destination to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return at one time.
nextToken	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

SELECT examples

get_topic_rule_destination

Gets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.

SELECT
arn,
created_at,
http_url_properties,
last_updated_at,
status,
status_reason,
vpc_properties
FROM aws.iot.topic_rule_destinations
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_topic_rule_destinations

Lists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.

SELECT
arn,
created_at,
http_url_summary,
last_updated_at,
status,
status_reason,
vpc_destination_summary
FROM aws.iot.topic_rule_destinations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_topic_rule_destination

Creates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.

INSERT INTO aws.iot.topic_rule_destinations (
destinationConfiguration,
region
)
SELECT 
'{{ destinationConfiguration }}' /* required */,
'{{ region }}'
RETURNING
topic_rule_destination
;

Manifest

# Description fields are for documentation purposes
- name: topic_rule_destinations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the topic_rule_destinations resource.
  - name: destinationConfiguration
    description: |
      Configuration of the topic rule destination.
    value:
      httpUrlConfiguration:
        confirmationUrl: "{{ confirmationUrl }}"
      vpcConfiguration:
        subnetIds:
          - "{{ subnetIds }}"
        securityGroups:
          - "{{ securityGroups }}"
        vpcId: "{{ vpcId }}"
        roleArn: "{{ roleArn }}"

UPDATE examples

update_topic_rule_destination

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination. Requires permission to access the UpdateTopicRuleDestination action.

UPDATE aws.iot.topic_rule_destinations
SET 
arn = '{{ arn }}',
status = '{{ status }}'
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
AND status = '{{ status }}' --required;

DELETE examples

delete_topic_rule_destination

Deletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.

DELETE FROM aws.iot.topic_rule_destinations
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;