Class: Aws::IoTSecureTunneling::Types::OpenTunnelRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsecuretunneling/types.rb

Overview

Note:

When making an API call, you may pass OpenTunnelRequest data as a hash:

{
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  destination_config: {
    thing_name: "ThingName",
    services: ["Service"], # required
  },
  timeout_config: {
    max_lifetime_timeout_minutes: 1,
  },
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A short text description of the tunnel.

Returns:

  • (String) 


231
232
233
234
235
236
237
238
 
# File 'lib/aws-sdk-iotsecuretunneling/types.rb', line 231

class OpenTunnelRequest < Struct.new(
  :description,
  :tags,
  :destination_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end

#destination_config ⇒ Types::DestinationConfig

The destination configuration for the OpenTunnel request.

Returns:



231
232
233
234
235
236
237
238
 
# File 'lib/aws-sdk-iotsecuretunneling/types.rb', line 231

class OpenTunnelRequest < Struct.new(
  :description,
  :tags,
  :destination_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A collection of tag metadata.

Returns:



231
232
233
234
235
236
237
238
 
# File 'lib/aws-sdk-iotsecuretunneling/types.rb', line 231

class OpenTunnelRequest < Struct.new(
  :description,
  :tags,
  :destination_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_config ⇒ Types::TimeoutConfig

Timeout configuration for a tunnel.

Returns:



231
232
233
234
235
236
237
238
 
# File 'lib/aws-sdk-iotsecuretunneling/types.rb', line 231

class OpenTunnelRequest < Struct.new(
  :description,
  :tags,
  :destination_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end