Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iotsecuretunneling ]

open-tunnel

Description

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server. .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  open-tunnel
[--description <value>]
[--tags <value>]
[--destination-config <value>]
[--timeout-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--description (string)

A short text description of the tunnel.

--tags (list)

A collection of tag metadata.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--destination-config (structure)

The destination configuration for the OpenTunnel request.

Shorthand Syntax:

thingName=string,services=string,string

JSON Syntax:

{
  "thingName": "string",
  "services": ["string", ...]
}

--timeout-config (structure)

Timeout configuration for a tunnel.

Shorthand Syntax:

maxLifetimeTimeoutMinutes=integer

JSON Syntax:

{
  "maxLifetimeTimeoutMinutes": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

tunnelId -> (string)

A unique alpha-numeric tunnel ID.

tunnelArn -> (string)

The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:region:account-id:tunnel/tunnel-id

sourceAccessToken -> (string)

The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.

destinationAccessToken -> (string)

The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.