package ec2instanceconnect

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

Package ec2instanceconnect provides the API client, operations, and parameter types for AWS EC2 Instance Connect.

AWS EC2 Connect Service is a service that enables system administrators to publish temporary SSH keys to their EC2 instances in order to establish connections to their instances without leaving a permanent authentication option.

Index ¶

• Constants
• func NewDefaultEndpointResolver() *internalendpoints.Resolver
• type Client
• func New(options Options, optFns ...func(*Options)) *Client
• func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
• func (c *Client) SendSSHPublicKey(ctx context.Context, params *SendSSHPublicKeyInput, optFns ...func(*Options)) (*SendSSHPublicKeyOutput, error)
• type EndpointResolver
• func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
• type EndpointResolverFunc
• func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
• type EndpointResolverOptions
• type HTTPClient
• type HTTPSignerV4
• type Options
• func (o Options) Copy() Options
• type ResolveEndpoint
• func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
• func (*ResolveEndpoint) ID() string
• type SendSSHPublicKeyInput
• type SendSSHPublicKeyOutput

Constants ¶

const ServiceAPIVersion = "2018-04-02"

const ServiceID = "EC2 Instance Connect"

Functions ¶

func NewDefaultEndpointResolver ¶

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types ¶

type Client ¶

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

Client provides the API client to make operations call for AWS EC2 Instance Connect.

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) SendSSHPublicKey ¶

func (c *Client) SendSSHPublicKey(ctx context.Context, params *SendSSHPublicKeyInput, optFns ...func(*Options)) (*SendSSHPublicKeyOutput, error)

Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.

type EndpointResolver ¶

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver ¶

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

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) error
}

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

	// 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 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 retry.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 (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID ¶

func (*ResolveEndpoint) ID() string

type SendSSHPublicKeyInput ¶

type SendSSHPublicKeyInput struct {

	// The availability zone the EC2 instance was launched in.
	//
	// This member is required.
	AvailabilityZone *string

	// The EC2 instance you wish to publish the SSH key to.
	//
	// This member is required.
	InstanceId *string

	// The OS user on the EC2 instance whom the key may be used to authenticate as.
	//
	// This member is required.
	InstanceOSUser *string

	// The public key to be published to the instance. To use it after publication you
	// must have the matching private key.
	//
	// This member is required.
	SSHPublicKey *string
}

type SendSSHPublicKeyOutput ¶

type SendSSHPublicKeyOutput struct {

	// The request ID as logged by EC2 Connect. Please provide this when contacting AWS
	// Support.
	RequestId *string

	// Indicates request success.
	Success *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files ¶

api_client.go api_op_SendSSHPublicKey.go deserializers.go doc.go endpoints.go serializers.go validators.go

Directories ¶