Package software.amazon.awssdk.services.ec2instanceconnect

Interface Ec2InstanceConnectClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface Ec2InstanceConnectClient
extends AwsClient

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

This is the Amazon EC2 Instance Connect API Reference. It provides descriptions, syntax, and usage examples for each of the actions for Amazon EC2 Instance Connect. Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH public keys to EC2, providing users a simple and secure way to connect to their instances.

To view the Amazon EC2 Instance Connect content in the Amazon EC2 User Guide, see Connect to your Linux instance using EC2 Instance Connect.

For Amazon EC2 APIs, see the Amazon EC2 API Reference.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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 SendSerialConsoleSshPublicKeyResponse	sendSerialConsoleSSHPublicKey(Consumer<SendSerialConsoleSshPublicKeyRequest.Builder> sendSerialConsoleSshPublicKeyRequest)	Pushes an SSH public key to the specified EC2 instance.
default SendSerialConsoleSshPublicKeyResponse	sendSerialConsoleSSHPublicKey(SendSerialConsoleSshPublicKeyRequest sendSerialConsoleSshPublicKeyRequest)	Pushes an SSH public key to the specified EC2 instance.
default SendSshPublicKeyResponse	sendSSHPublicKey(Consumer<SendSshPublicKeyRequest.Builder> sendSshPublicKeyRequest)	Pushes an SSH public key to the specified EC2 instance for use by the specified user.
default SendSshPublicKeyResponse	sendSSHPublicKey(SendSshPublicKeyRequest sendSshPublicKeyRequest)	Pushes an SSH public key to the specified EC2 instance for use by the specified user.
default Ec2InstanceConnectServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

sendSSHPublicKey

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

Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide.

Parameters:

sendSshPublicKeyRequest -

Returns:

Result of the SendSSHPublicKey operation returned by the service.

See Also:

• AWS API Documentation

sendSSHPublicKey

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

Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide.

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.

See Also:

• AWS API Documentation

sendSerialConsoleSSHPublicKey

default SendSerialConsoleSshPublicKeyResponse sendSerialConsoleSSHPublicKey(SendSerialConsoleSshPublicKeyRequest sendSerialConsoleSshPublicKeyRequest)
                                                                     throws AuthException,
SerialConsoleAccessDisabledException,
InvalidArgsException,
ServiceException,
ThrottlingException,
Ec2InstanceNotFoundException,
Ec2InstanceTypeInvalidException,
SerialConsoleSessionLimitExceededException,
SerialConsoleSessionUnavailableException,
Ec2InstanceStateInvalidException,
Ec2InstanceUnavailableException,
SerialConsoleSessionUnsupportedException,
AwsServiceException,
SdkClientException,
Ec2InstanceConnectException

Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.

Parameters:

sendSerialConsoleSshPublicKeyRequest -

Returns:

Result of the SendSerialConsoleSSHPublicKey operation returned by the service.

See Also:

• AWS API Documentation

sendSerialConsoleSSHPublicKey

default SendSerialConsoleSshPublicKeyResponse sendSerialConsoleSSHPublicKey(Consumer<SendSerialConsoleSshPublicKeyRequest.Builder> sendSerialConsoleSshPublicKeyRequest)
                                                                     throws AuthException,
SerialConsoleAccessDisabledException,
InvalidArgsException,
ServiceException,
ThrottlingException,
Ec2InstanceNotFoundException,
Ec2InstanceTypeInvalidException,
SerialConsoleSessionLimitExceededException,
SerialConsoleSessionUnavailableException,
Ec2InstanceStateInvalidException,
Ec2InstanceUnavailableException,
SerialConsoleSessionUnsupportedException,
AwsServiceException,
SdkClientException,
Ec2InstanceConnectException

Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.

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

Parameters:

sendSerialConsoleSshPublicKeyRequest - A Consumer that will call methods on SendSerialConsoleSshPublicKeyRequest.Builder to create a request.

Returns:

Result of the SendSerialConsoleSSHPublicKey operation returned by the service.

See Also:

• AWS API Documentation

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.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default Ec2InstanceConnectServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration