You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTSecureTunneling::Types::Tunnel

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A connection between a source computer and a destination device.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The time when the tunnel was created.

Returns:

  • (Time) —

    The time when the tunnel was created.

#description ⇒ String

A description of the tunnel.

Returns:

  • (String) —

    A description of the tunnel.

#destination_config ⇒ Types::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.

Returns:

  • (Types::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.

#destination_connection_state ⇒ Types::ConnectionState

The connection state of the destination application.

Returns:

#last_updated_at ⇒ Time

The last time the tunnel was updated.

Returns:

  • (Time) —

    The last time the tunnel was updated.

#source_connection_state ⇒ Types::ConnectionState

The connection state of the source application.

Returns:

#status ⇒ String

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

Possible values:

  • OPEN
  • CLOSED

Returns:

  • (String) —

    The status of a tunnel.

#tags ⇒ Array<Types::Tag>

A list of tag metadata associated with the secure tunnel.

Returns:

  • (Array<Types::Tag>) —

    A list of tag metadata associated with the secure tunnel.

#timeout_config ⇒ Types::TimeoutConfig

Timeout configuration for the tunnel.

Returns:

#tunnel_arn ⇒ String

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of a tunnel.

#tunnel_id ⇒ String

A unique alpha-numeric ID that identifies a tunnel.

Returns:

  • (String) —

    A unique alpha-numeric ID that identifies a tunnel.