topic_rule_destinations

Creates, updates, deletes or gets a topic_rule_destination resource or lists topic_rule_destinations in a region

Overview

Name	topic_rule_destinations
Type	Resource
Description	Resource Type definition for AWS::IoT::TopicRuleDestination
Id	aws.iot.topic_rule_destinations

Fields

Name	Datatype	Description
arn	string	Amazon Resource Name (ARN).
status	string	The status of the TopicRuleDestination.
http_url_properties	object	HTTP URL destination properties.
status_reason	string	The reasoning for the current status of the TopicRuleDestination.
vpc_properties	object	VPC destination properties.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all topic_rule_destinations in a region.

SELECT
region,
arn,
status,
http_url_properties,
status_reason,
vpc_properties
FROM aws.iot.topic_rule_destinations
WHERE region = 'us-east-1';

Gets all properties from an individual topic_rule_destination.

SELECT
region,
arn,
status,
http_url_properties,
status_reason,
vpc_properties
FROM aws.iot.topic_rule_destinations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new topic_rule_destination resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iot.topic_rule_destinations (
 Status,
 HttpUrlProperties,
 VpcProperties,
 region
)
SELECT 
'{{ Status }}',
 '{{ HttpUrlProperties }}',
 '{{ VpcProperties }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iot.topic_rule_destinations (
 Status,
 HttpUrlProperties,
 VpcProperties,
 region
)
SELECT 
 '{{ Status }}',
 '{{ HttpUrlProperties }}',
 '{{ VpcProperties }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: topic_rule_destination
    props:
      - name: Status
        value: '{{ Status }}'
      - name: HttpUrlProperties
        value:
          ConfirmationUrl: '{{ ConfirmationUrl }}'
      - name: VpcProperties
        value:
          SubnetIds:
            - '{{ SubnetIds[0] }}'
          SecurityGroups:
            - '{{ SecurityGroups[0] }}'
          VpcId: '{{ VpcId }}'
          RoleArn: '{{ RoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.iot.topic_rule_destinations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the topic_rule_destinations resource, the following permissions are required:

Create

iam:PassRole,
iot:CreateTopicRuleDestination,
iot:GetTopicRuleDestination,
iot:UpdateTopicRuleDestination

Read

iot:GetTopicRuleDestination

Update

iam:PassRole,
iot:GetTopicRuleDestination,
iot:UpdateTopicRuleDestination

Delete

iot:GetTopicRuleDestination,
iot:DeleteTopicRuleDestination

List

iot:ListTopicRuleDestinations