package types

import "github.com/aws/aws-sdk-go-v2/service/iotsecuretunneling/types"

Index

Types

type ConnectionState

type ConnectionState struct {

	// The last time the connection status was updated.
	LastUpdatedAt *time.Time

	// The connection status of the tunnel. Valid values are CONNECTED and
	// DISCONNECTED.
	Status ConnectionStatus
	// contains filtered or unexported fields
}

The state of a connection.

type ConnectionStatus

type ConnectionStatus string
const (
	ConnectionStatusConnected    ConnectionStatus = "CONNECTED"
	ConnectionStatusDisconnected ConnectionStatus = "DISCONNECTED"
)

Enum values for ConnectionStatus

func (ConnectionStatus) Values

Values returns all known values for ConnectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DestinationConfig

type DestinationConfig struct {

	// A list of service names that identity the target application. The AWS IoT client
	// running on the destination device reads this value and uses it to look up a port
	// or an IP address and a port. The AWS IoT client instantiates the local proxy
	// which uses this information to connect to the destination application.
	//
	// This member is required.
	Services []string

	// The name of the IoT thing to which you want to connect.
	ThingName *string
	// contains filtered or unexported fields
}

The destination configuration.

type LimitExceededException

type LimitExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

Thrown when a tunnel limit is exceeded.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

Thrown when an operation is attempted on a resource that does not exist.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type Tag

type Tag struct {

	// The key of the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

An arbitary key/value pair used to add searchable metadata to secure tunnel resources.

type TimeoutConfig

type TimeoutConfig struct {

	// The maximum amount of time (in minutes) a tunnel can remain open. If not
	// specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are
	// from 1 minute to 12 hours (720 minutes)
	MaxLifetimeTimeoutMinutes int32
	// contains filtered or unexported fields
}

Tunnel timeout configuration.

type Tunnel

type Tunnel struct {

	// The time when the tunnel was created.
	CreatedAt *time.Time

	// A description of the tunnel.
	Description *string

	// 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.
	DestinationConfig *DestinationConfig

	// The connection state of the destination application.
	DestinationConnectionState *ConnectionState

	// The last time the tunnel was updated.
	LastUpdatedAt *time.Time

	// The connection state of the source application.
	SourceConnectionState *ConnectionState

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

	// A list of tag metadata associated with the secure tunnel.
	Tags []Tag

	// Timeout configuration for the tunnel.
	TimeoutConfig *TimeoutConfig

	// The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is
	// arn:aws:tunnel:::tunnel/
	TunnelArn *string

	// A unique alpha-numeric ID that identifies a tunnel.
	TunnelId *string
	// contains filtered or unexported fields
}

A connection between a source computer and a destination device.

type TunnelStatus

type TunnelStatus string
const (
	TunnelStatusOpen   TunnelStatus = "OPEN"
	TunnelStatusClosed TunnelStatus = "CLOSED"
)

Enum values for TunnelStatus

func (TunnelStatus) Values

func (TunnelStatus) Values() []TunnelStatus

Values returns all known values for TunnelStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TunnelSummary

type TunnelSummary struct {

	// The time the tunnel was created.
	CreatedAt *time.Time

	// A description of the tunnel.
	Description *string

	// The time the tunnel was last updated.
	LastUpdatedAt *time.Time

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

	// The Amazon Resource Name of the tunnel. The tunnel ARN format is
	// arn:aws:tunnel:::tunnel/
	TunnelArn *string

	// The unique alpha-numeric identifier for the tunnel.
	TunnelId *string
	// contains filtered or unexported fields
}

Information about the tunnel.

Source Files

enums.go errors.go types.go

Version
v1.8.0
Published
Dec 21, 2021
Platform
js/wasm
Imports
4 packages
Last checked
3 hours ago

Tools for package owners.