Tunnel - AWS IoT
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

Tunnel

A connection between a source computer and a destination device.

Contents

createdAt

The time when the tunnel was created.

Type: Timestamp

Required: No

description

A description of the tunnel.

Type: String

Pattern: [^\p{C}]{1,2048}

Required: No

destinationConfig

The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.

Type: DestinationConfig object

Required: No

destinationConnectionState

The connection state of the destination application.

Type: ConnectionState object

Required: No

lastUpdatedAt

The last time the tunnel was updated.

Type: Timestamp

Required: No

sourceConnectionState

The connection state of the source application.

Type: ConnectionState object

Required: No

status

The status of a tunnel. Valid values are: Open and Closed.

Type: String

Valid Values: OPEN | CLOSED

Required: No

tags

A list of tag metadata associated with the secure tunnel.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

timeoutConfig

Timeout configuration for the tunnel.

Type: TimeoutConfig object

Required: No

tunnelArn

The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No

tunnelId

A unique alpha-numeric ID that identifies a tunnel.

Type: String

Pattern: [a-zA-Z0-9_\-+=:]{1,128}

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: