AWS::IoTSecureTunneling::Tunnel

IoTSecureTunneling Tunnel

A connection between a source computer and a destination device using AWS IoT Secure Tunneling.

Properties

4 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
Description
string
Create-only
DestinationConfig
DestinationConfig
Create-only
Tags
Array<Tag>
TimeoutConfig
TimeoutConfig
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
StatusstringThe status of the tunnel. Valid values are OPEN and CLOSED.
TunnelArnstringThe Amazon Resource Name (ARN) of the tunnel.
TunnelIdstringA unique alpha-numeric tunnel ID.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoTSecureTunneling::Tunnel

Resources:
  MyResource:
    Type: AWS::IoTSecureTunneling::Tunnel
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iot:OpenTunneliot:TagResource

read

iot:DescribeTunneliot:ListTagsForResource

update

iot:DescribeTunneliot:TagResourceiot:UntagResourceiot:ListTagsForResource

delete

iot:CloseTunneliot:DescribeTunnel

list

iot:ListTunnels

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoTSecureTunneling
Properties7
Required0
TaggingSupported
Primary IDTunnelArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DescriptionDestinationConfigTimeoutConfig

External Links