Documentation

Overview

    Package iotsecuretunneling provides the API client, operations, and parameter types for AWS IoT Secure Tunneling.

    AWS IoT Secure Tunneling AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field. For more information about how AWS IoT Secure Tunneling works, see AWS IoT Secure Tunneling (https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html).

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-10-05"
    View Source
    const ServiceID = "IoTSecureTunneling"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS IoT Secure Tunneling.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CloseTunnel

                func (c *Client) CloseTunnel(ctx context.Context, params *CloseTunnelInput, optFns ...func(*Options)) (*CloseTunnelOutput, error)

                  Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

                  func (*Client) DescribeTunnel

                  func (c *Client) DescribeTunnel(ctx context.Context, params *DescribeTunnelInput, optFns ...func(*Options)) (*DescribeTunnelOutput, error)

                    Gets information about a tunnel identified by the unique tunnel id.

                    func (*Client) ListTagsForResource

                    func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

                      Lists the tags for the specified resource.

                      func (*Client) ListTunnels

                      func (c *Client) ListTunnels(ctx context.Context, params *ListTunnelsInput, optFns ...func(*Options)) (*ListTunnelsOutput, error)

                        List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

                        func (*Client) OpenTunnel

                        func (c *Client) OpenTunnel(ctx context.Context, params *OpenTunnelInput, optFns ...func(*Options)) (*OpenTunnelOutput, error)

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

                          func (*Client) TagResource

                          func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

                            A resource tag.

                            func (*Client) UntagResource

                            func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

                              Removes a tag from a resource.

                              type CloseTunnelInput

                              type CloseTunnelInput struct {
                              
                              	// The ID of the tunnel to close.
                              	//
                              	// This member is required.
                              	TunnelId *string
                              
                              	// When set to true, AWS IoT Secure Tunneling deletes the tunnel data immediately.
                              	Delete bool
                              }

                              type CloseTunnelOutput

                              type CloseTunnelOutput struct {
                              	// Metadata pertaining to the operation's result.
                              	ResultMetadata middleware.Metadata
                              }

                              type DescribeTunnelInput

                              type DescribeTunnelInput struct {
                              
                              	// The tunnel to describe.
                              	//
                              	// This member is required.
                              	TunnelId *string
                              }

                              type DescribeTunnelOutput

                              type DescribeTunnelOutput struct {
                              
                              	// The tunnel being described.
                              	Tunnel *types.Tunnel
                              
                              	// Metadata pertaining to the operation's result.
                              	ResultMetadata middleware.Metadata
                              }

                              type EndpointResolver

                              type EndpointResolver interface {
                              	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                              }

                                EndpointResolver interface for resolving service endpoints.

                                func EndpointResolverFromURL

                                func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                  EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                  type EndpointResolverFunc

                                  type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                    EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                    func (EndpointResolverFunc) ResolveEndpoint

                                    func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                    type EndpointResolverOptions

                                    type EndpointResolverOptions = internalendpoints.Options

                                      EndpointResolverOptions is the service endpoint resolver options

                                      type HTTPClient

                                      type HTTPClient interface {
                                      	Do(*http.Request) (*http.Response, error)
                                      }

                                      type HTTPSignerV4

                                      type HTTPSignerV4 interface {
                                      	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                      }

                                      type ListTagsForResourceInput

                                      type ListTagsForResourceInput struct {
                                      
                                      	// The resource ARN.
                                      	//
                                      	// This member is required.
                                      	ResourceArn *string
                                      }

                                      type ListTagsForResourceOutput

                                      type ListTagsForResourceOutput struct {
                                      
                                      	// The tags for the specified resource.
                                      	Tags []types.Tag
                                      
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

                                      type ListTunnelsAPIClient

                                      type ListTunnelsAPIClient interface {
                                      	ListTunnels(context.Context, *ListTunnelsInput, ...func(*Options)) (*ListTunnelsOutput, error)
                                      }

                                        ListTunnelsAPIClient is a client that implements the ListTunnels operation.

                                        type ListTunnelsInput

                                        type ListTunnelsInput struct {
                                        
                                        	// The maximum number of results to return at once.
                                        	MaxResults int32
                                        
                                        	// A token to retrieve the next set of results.
                                        	NextToken *string
                                        
                                        	// The name of the IoT thing associated with the destination device.
                                        	ThingName *string
                                        }

                                        type ListTunnelsOutput

                                        type ListTunnelsOutput struct {
                                        
                                        	// A token to used to retrieve the next set of results.
                                        	NextToken *string
                                        
                                        	// A short description of the tunnels in an AWS account.
                                        	TunnelSummaries []types.TunnelSummary
                                        
                                        	// Metadata pertaining to the operation's result.
                                        	ResultMetadata middleware.Metadata
                                        }

                                        type ListTunnelsPaginator

                                        type ListTunnelsPaginator struct {
                                        	// contains filtered or unexported fields
                                        }

                                          ListTunnelsPaginator is a paginator for ListTunnels

                                          func NewListTunnelsPaginator

                                          func NewListTunnelsPaginator(client ListTunnelsAPIClient, params *ListTunnelsInput, optFns ...func(*ListTunnelsPaginatorOptions)) *ListTunnelsPaginator

                                            NewListTunnelsPaginator returns a new ListTunnelsPaginator

                                            func (*ListTunnelsPaginator) HasMorePages

                                            func (p *ListTunnelsPaginator) HasMorePages() bool

                                              HasMorePages returns a boolean indicating whether more pages are available

                                              func (*ListTunnelsPaginator) NextPage

                                              func (p *ListTunnelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTunnelsOutput, error)

                                                NextPage retrieves the next ListTunnels page.

                                                type ListTunnelsPaginatorOptions

                                                type ListTunnelsPaginatorOptions struct {
                                                	// The maximum number of results to return at once.
                                                	Limit int32
                                                
                                                	// Set to true if pagination should stop if the service returns a pagination token
                                                	// that matches the most recent token provided to the service.
                                                	StopOnDuplicateToken bool
                                                }

                                                  ListTunnelsPaginatorOptions is the paginator options for ListTunnels

                                                  type OpenTunnelInput

                                                  type OpenTunnelInput struct {
                                                  
                                                  	// A short text description of the tunnel.
                                                  	Description *string
                                                  
                                                  	// The destination configuration for the OpenTunnel request.
                                                  	DestinationConfig *types.DestinationConfig
                                                  
                                                  	// A collection of tag metadata.
                                                  	Tags []types.Tag
                                                  
                                                  	// Timeout configuration for a tunnel.
                                                  	TimeoutConfig *types.TimeoutConfig
                                                  }

                                                  type OpenTunnelOutput

                                                  type OpenTunnelOutput struct {
                                                  
                                                  	// The access token the destination local proxy uses to connect to AWS IoT Secure
                                                  	// Tunneling.
                                                  	DestinationAccessToken *string
                                                  
                                                  	// The access token the source local proxy uses to connect to AWS IoT Secure
                                                  	// Tunneling.
                                                  	SourceAccessToken *string
                                                  
                                                  	// The Amazon Resource Name for the tunnel. The tunnel ARN format is
                                                  	// arn:aws:tunnel:::tunnel/
                                                  	TunnelArn *string
                                                  
                                                  	// A unique alpha-numeric tunnel ID.
                                                  	TunnelId *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type Options

                                                  type Options struct {
                                                  	// Set of options to modify how an operation is invoked. These apply to all
                                                  	// operations invoked for this client. Use functional options on operation call to
                                                  	// modify this list for per operation behavior.
                                                  	APIOptions []func(*middleware.Stack) error
                                                  
                                                  	// Configures the events that will be sent to the configured logger.
                                                  	ClientLogMode aws.ClientLogMode
                                                  
                                                  	// The credentials object to use when signing requests.
                                                  	Credentials aws.CredentialsProvider
                                                  
                                                  	// The endpoint options to be used when attempting to resolve an endpoint.
                                                  	EndpointOptions EndpointResolverOptions
                                                  
                                                  	// The service endpoint resolver.
                                                  	EndpointResolver EndpointResolver
                                                  
                                                  	// Signature Version 4 (SigV4) Signer
                                                  	HTTPSignerV4 HTTPSignerV4
                                                  
                                                  	// The logger writer interface to write logging messages to.
                                                  	Logger logging.Logger
                                                  
                                                  	// The region to send requests to. (Required)
                                                  	Region string
                                                  
                                                  	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                  	// failures. When nil the API client will use a default retryer.
                                                  	Retryer aws.Retryer
                                                  
                                                  	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                  	// implementation if nil.
                                                  	HTTPClient HTTPClient
                                                  }

                                                  func (Options) Copy

                                                  func (o Options) Copy() Options

                                                    Copy creates a clone where the APIOptions list is deep copied.

                                                    type ResolveEndpoint

                                                    type ResolveEndpoint struct {
                                                    	Resolver EndpointResolver
                                                    	Options  EndpointResolverOptions
                                                    }

                                                    func (*ResolveEndpoint) HandleSerialize

                                                    func (*ResolveEndpoint) ID

                                                    func (*ResolveEndpoint) ID() string

                                                    type TagResourceInput

                                                    type TagResourceInput struct {
                                                    
                                                    	// The ARN of the resource.
                                                    	//
                                                    	// This member is required.
                                                    	ResourceArn *string
                                                    
                                                    	// The tags for the resource.
                                                    	//
                                                    	// This member is required.
                                                    	Tags []types.Tag
                                                    }

                                                    type TagResourceOutput

                                                    type TagResourceOutput struct {
                                                    	// Metadata pertaining to the operation's result.
                                                    	ResultMetadata middleware.Metadata
                                                    }

                                                    type UntagResourceInput

                                                    type UntagResourceInput struct {
                                                    
                                                    	// The resource ARN.
                                                    	//
                                                    	// This member is required.
                                                    	ResourceArn *string
                                                    
                                                    	// The keys of the tags to remove.
                                                    	//
                                                    	// This member is required.
                                                    	TagKeys []string
                                                    }

                                                    type UntagResourceOutput

                                                    type UntagResourceOutput struct {
                                                    	// Metadata pertaining to the operation's result.
                                                    	ResultMetadata middleware.Metadata
                                                    }

                                                    Directories

                                                    Path Synopsis
                                                    internal