Package software.amazon.awssdk.auth

Class ElasticContainerCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.ElasticContainerCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider

public class ElasticContainerCredentialsProvider
extends Object
implements AwsCredentialsProvider, AutoCloseable

AwsCredentialsProvider implementation that loads credentials from the Amazon Elastic Container Service.

The URI path is retrieved from the environment variable "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" in the container's environment. If the environment variable is not set, this credentials provider will always return null.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ElasticContainerCredentialsProvider()	Create an instance of this provider using the default configuration.

Method Summary

Modifier and Type	Method	Description
static ElasticContainerCredentialsProvider.Builder	builder()	Create a builder for creating a ElasticContainerCredentialsProvider.
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

Constructor Detail

ElasticContainerCredentialsProvider

public ElasticContainerCredentialsProvider()

Create an instance of this provider using the default configuration. For custom configuration, see builder().

Method Detail

builder

public static ElasticContainerCredentialsProvider.Builder builder()

Create a builder for creating a ElasticContainerCredentialsProvider.

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()

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object