com.amazonaws.auth

Class ContainerCredentialsProvider

java.lang.Object

com.amazonaws.auth.ContainerCredentialsProvider

All Implemented Interfaces:

AWSCredentialsProvider

public class ContainerCredentialsProvider
extends Object
implements AWSCredentialsProvider

AWSCredentialsProvider implementation that loads credentials from a local metadata service.

Currently supported containers:

• Amazon Elastic Container Service (ECS)
• Amazon Elastic Kubernetes Service (EKS)
• 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. Resolving to use relative or absolute path is the role of EC2ContainerCredentialsProviderWrapper.

Full (absolute) URI configuration

For absolute paths, only loopback hosts are allowed when using HTTP, including known endpoints for ECS and EKS. All HTTPS endpoints are allowed.

IPv6 addresses are supported when setting the "AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE" environment variable.

Optionally, an authorization token can be included in the "Authorization" header of the request. There are two ways of providing the token, in order of priority:

• Setting the "AWS_CONTAINER_AUTHORIZATION_TOKEN" environment variable
• Entering the token into a file and providing the path to it using the "AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE" environment variable. Note that the token content will be used as-is.

.

Migrating to the AWS SDK for Java v2

The v2 equivalent of this class is ContainerCredentialsProvider

See Migration Guide for more information.

Constructor Summary

Constructors

Constructor and Description
ContainerCredentialsProvider() Deprecated. use ContainerCredentialsProvider(CredentialsEndpointProvider)
ContainerCredentialsProvider(CredentialsEndpointProvider credentialsEndpointProvider)

Method Summary

Modifier and Type	Method and Description
AWSCredentials	getCredentials() Returns AWSCredentials which the caller can use to authorize an AWS request.
Date	getCredentialsExpiration()
void	refresh() Forces this credentials provider to refresh its credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerCredentialsProvider

@Deprecated
public ContainerCredentialsProvider()

Deprecated. use ContainerCredentialsProvider(CredentialsEndpointProvider)

ContainerCredentialsProvider

public ContainerCredentialsProvider(CredentialsEndpointProvider credentialsEndpointProvider)

Method Detail

getCredentials

public AWSCredentials getCredentials()

Description copied from interface: AWSCredentialsProvider

Returns AWSCredentials which the caller can use 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.

Specified by:

getCredentials in interface AWSCredentialsProvider

Returns:

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

refresh

public void refresh()

Description copied from interface: AWSCredentialsProvider

Forces this credentials provider to refresh its credentials. For many implementations of credentials provider, this method may simply be a no-op, such as any credentials provider implementation that vends static/non-changing credentials. For other implementations that vend different credentials through out their lifetime, this method should force the credentials provider to refresh its credentials.

Specified by:

refresh in interface AWSCredentialsProvider

getCredentialsExpiration

public Date getCredentialsExpiration()