software.amazon.awssdk.services.ec2instanceconnect

Interface Ec2InstanceConnectClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface Ec2InstanceConnectClient
extends SdkClient

Service client for accessing EC2 Instance Connect. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static Ec2InstanceConnectClientBuilder	builder() Create a builder that can be used to configure and create a Ec2InstanceConnectClient.
static Ec2InstanceConnectClient	create() Create a Ec2InstanceConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default SendSshPublicKeyResponse	sendSSHPublicKey(Consumer<SendSshPublicKeyRequest.Builder> sendSshPublicKeyRequest) Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.
default SendSshPublicKeyResponse	sendSSHPublicKey(SendSshPublicKeyRequest sendSshPublicKeyRequest) Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static Ec2InstanceConnectClient create()

Create a Ec2InstanceConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static Ec2InstanceConnectClientBuilder builder()

Create a builder that can be used to configure and create a Ec2InstanceConnectClient.

sendSSHPublicKey

default SendSshPublicKeyResponse sendSSHPublicKey(SendSshPublicKeyRequest sendSshPublicKeyRequest)
                                           throws AuthException,
                                                  InvalidArgsException,
                                                  ServiceException,
                                                  ThrottlingException,
                                                  Ec2InstanceNotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  Ec2InstanceConnectException

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

Parameters:

sendSshPublicKeyRequest -

Returns:

Result of the SendSSHPublicKey operation returned by the service.

Throws:

AuthException - Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.

InvalidArgsException - Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.

ServiceException - Indicates that the service encountered an error. Follow the message's instructions and try again.

ThrottlingException - Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.

Ec2InstanceNotFoundException - Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

Ec2InstanceConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

sendSSHPublicKey

default SendSshPublicKeyResponse sendSSHPublicKey(Consumer<SendSshPublicKeyRequest.Builder> sendSshPublicKeyRequest)
                                           throws AuthException,
                                                  InvalidArgsException,
                                                  ServiceException,
                                                  ThrottlingException,
                                                  Ec2InstanceNotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  Ec2InstanceConnectException

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

This is a convenience which creates an instance of the SendSshPublicKeyRequest.Builder avoiding the need to create one manually via SendSshPublicKeyRequest.builder()

Parameters:

sendSshPublicKeyRequest - A Consumer that will call methods on SendSSHPublicKeyRequest.Builder to create a request.

Returns:

Result of the SendSSHPublicKey operation returned by the service.

Throws:

AuthException - Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.

InvalidArgsException - Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.

ServiceException - Indicates that the service encountered an error. Follow the message's instructions and try again.

ThrottlingException - Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.

Ec2InstanceNotFoundException - Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

Ec2InstanceConnectException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()