destinations

Creates, updates, deletes or gets a destination resource or lists destinations in a region

Overview

Name	destinations
Type	Resource
Description	Destination's resource schema demonstrating some basic constructs and validation rules.
Id	awscc.iotwireless.destinations

Fields

get (all properties)

Name	Datatype	Description
name	string	Unique name of destination
expression	string	Destination expression
expression_type	string	Must be RuleName
description	string	Destination description
▶tags	array	A list of key-value pairs that contain metadata for the destination.
role_arn	string	AWS role ARN that grants access
arn	string	Destination arn. Returned after successful create.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	Unique name of destination
region	string	AWS region.

For more information, see AWS::IoTWireless::Destination.

Methods

Name	Resource	Accessible by	Required Params
create_resource	destinations	INSERT	Name, Expression, ExpressionType, region
delete_resource	destinations	DELETE	Identifier, region
update_resource	destinations	UPDATE	Identifier, PatchDocument, region
list_resources	destinations_list_only	SELECT	region
get_resource	destinations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual destination.

SELECT
  region,
  name,
  expression,
  expression_type,
  description,
  tags,
  role_arn,
  arn
FROM awscc.iotwireless.destinations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all destinations in a region.

SELECT
  region,
  name
FROM awscc.iotwireless.destinations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iotwireless.destinations (
  Name,
  Expression,
  ExpressionType,
  region
)
SELECT
  '{{ name }}',
  '{{ expression }}',
  '{{ expression_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotwireless.destinations (
  Name,
  Expression,
  ExpressionType,
  Description,
  Tags,
  RoleArn,
  region
)
SELECT
  '{{ name }}',
  '{{ expression }}',
  '{{ expression_type }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: destination
  props:
    - name: name
      value: '{{ name }}'
    - name: expression
      value: '{{ expression }}'
    - name: expression_type
      value: '{{ expression_type }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: role_arn
      value: '{{ role_arn }}'

UPDATE example

Use the following StackQL query and manifest file to update a destination resource, using stack-deploy.

/*+ update */
UPDATE awscc.iotwireless.destinations
SET PatchDocument = string('{{ {
    "Expression": expression,
    "ExpressionType": expression_type,
    "Description": description,
    "Tags": tags,
    "RoleArn": role_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotwireless.destinations
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

iam:PassRole,
iotwireless:CreateDestination,
iotwireless:TagResource

Read

iotwireless:GetDestination,
iotwireless:ListTagsForResource

Update

iam:PassRole,
iotwireless:GetDestination,
iotwireless:UpdateDestination,
iotwireless:UntagResource,
iotwireless:TagResource

Delete

iotwireless:DeleteDestination

List

iotwireless:ListDestinations,
iotwireless:ListTagsForResource