Package software.amazon.awssdk.services.eksauth

Interface EksAuthClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing Amazon EKS Auth. This can be created using the static builder() method.

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

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
default AssumeRoleForPodIdentityResponse	assumeRoleForPodIdentity(Consumer<AssumeRoleForPodIdentityRequest.Builder> assumeRoleForPodIdentityRequest)	The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.
default AssumeRoleForPodIdentityResponse	assumeRoleForPodIdentity(AssumeRoleForPodIdentityRequest assumeRoleForPodIdentityRequest)	The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.
static EksAuthClientBuilder	builder()	Create a builder that can be used to configure and create a EksAuthClient.
static EksAuthClient	create()	Create a EksAuthClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default EksAuthServiceClientConfiguration	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

assumeRoleForPodIdentity

default AssumeRoleForPodIdentityResponse assumeRoleForPodIdentity(AssumeRoleForPodIdentityRequest assumeRoleForPodIdentityRequest)
                                                           throws ThrottlingException,
InvalidRequestException,
AccessDeniedException,
InternalServerException,
InvalidTokenException,
InvalidParameterException,
ExpiredTokenException,
ResourceNotFoundException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
EksAuthException

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

Parameters:

assumeRoleForPodIdentityRequest -

Returns:

Result of the AssumeRoleForPodIdentity operation returned by the service.

See Also:

• AWS API Documentation

assumeRoleForPodIdentity

default AssumeRoleForPodIdentityResponse assumeRoleForPodIdentity(Consumer<AssumeRoleForPodIdentityRequest.Builder> assumeRoleForPodIdentityRequest)
                                                           throws ThrottlingException,
InvalidRequestException,
AccessDeniedException,
InternalServerException,
InvalidTokenException,
InvalidParameterException,
ExpiredTokenException,
ResourceNotFoundException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
EksAuthException

The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent.

We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.

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

Parameters:

assumeRoleForPodIdentityRequest - A Consumer that will call methods on AssumeRoleForPodIdentityRequest.Builder to create a request.

Returns:

Result of the AssumeRoleForPodIdentity operation returned by the service.

See Also:

• AWS API Documentation

create

static EksAuthClient create()

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

builder

static EksAuthClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default EksAuthServiceClientConfiguration 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