AWS::IoTWireless::Destination

Creates a new destination that maps a device message to an AWS IoT rule.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTWireless::Destination",
  "Properties" : {
      "Description" : String,
      "Expression" : String,
      "ExpressionType" : String,
      "Name" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTWireless::Destination
Properties: 
  Description: String
  Expression: String
  ExpressionType: String
  Name: String
  RoleArn: String
  Tags: 
    - Tag

Properties

Description

The description of the new resource. Maximum length is 2048 characters.

Required: No

Type: String

Update requires: No interruption

Expression

The rule name to send messages to. Maximum length is 2048.

Required: Yes

Type: String

Update requires: No interruption

ExpressionType

The type of value in Expression. Must be RuleName or MqttTopic.

Required: Yes

Type: String

Update requires: No interruption

Name

The name of the new resource. The maximum length is 128 characters. It can have only have alphanumeric, - (hyphen) and _ (underscore) characters and it can't have any spaces.

Required: Yes

Type: String

Update requires: Replacement

RoleArn

The ARN of the IAM Role that authorizes the destination. Minimum length is 20 and maximum length is 2048.

Required: Yes

Type: String

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource. Tags can have a minimum of 0 and a maximum of 50 items.

For more information, see Tag.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Destination name.

Fn::GetAtt

Arn

The ARN of the destination created.