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
Maximum:
2048
Update requires: No interruption
Expression
-
The rule name to send messages to.
Required: Yes
Type: String
Maximum:
2048
Update requires: No interruption
ExpressionType
-
The type of value in
Expression
.Required: Yes
Type: String
Allowed values:
RuleName | MqttTopic | SnsTopic
Update requires: No interruption
Name
-
The name of the new resource.
Required: Yes
Type: String
Pattern:
[a-zA-Z0-9:_-]+
Maximum:
128
Update requires: Replacement
RoleArn
-
The ARN of the IAM Role that authorizes the destination.
Required: No
Type: String
Minimum:
20
Maximum:
2048
Update requires: No interruption
-
The tags are an array of key-value pairs to attach to the specified resource. Tags can have a minimum of 0 and a maximum of 50 items.
Required: No
Type: Array of Tag
Maximum:
200
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.