software.amazon.awssdk.auth.credentials

Class ContainerCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.ContainerCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

public final class ContainerCredentialsProvider
extends Object

AwsCredentialsProvider implementation that loads credentials from a local metadata service. Currently supported containers:

• Amazon Elastic Container Service (ECS)
• AWS Greengrass

The URI path is retrieved from the environment variable "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" or "AWS_CONTAINER_CREDENTIALS_FULL_URI" in the container's environment. If the environment variable is not set, this credentials provider will throw an exception.

See Also:

Amazon Elastic Container Service (ECS)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainerCredentialsProvider.Builder A builder for creating a custom a ContainerCredentialsProvider.

Method Summary

Modifier and Type	Method and Description
static ContainerCredentialsProvider.Builder	builder() Create a builder for creating a ContainerCredentialsProvider.
void	close()
AwsCredentials	getCredentials() Returns AwsCredentials that can be used to authorize an AWS request.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ContainerCredentialsProvider.Builder builder()

Create a builder for creating a ContainerCredentialsProvider.

toString

public String toString()

Overrides:

toString in class Object

getCredentials

public AwsCredentials getCredentials()

Description copied from interface: AwsCredentialsProvider

Returns AwsCredentials that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated.

If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.

Specified by:

getCredentials in interface AwsCredentialsProvider

Returns:

AwsCredentials which the caller can use to authorize an AWS request.

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable