Package software.amazon.awssdk.auth

Class DefaultCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.DefaultCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider

public class DefaultCredentialsProvider
extends Object
implements AwsCredentialsProvider, AutoCloseable

AWS credentials provider chain that looks for credentials in this order:

1. Java System Properties - aws.accessKeyId and aws.secretKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
4. Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" environment variable is set and security manager has permission to access the variable,
5. Instance profile credentials delivered through the Amazon EC2 metadata service

See Also:

SystemPropertyCredentialsProvider, EnvironmentVariableCredentialsProvider, ProfileCredentialsProvider, ElasticContainerCredentialsProvider, InstanceProfileCredentialsProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultCredentialsProvider.Builder	Configuration that defines the DefaultCredentialsProvider's behavior.

Constructor Summary

Constructors

Constructor	Description
DefaultCredentialsProvider()	Create an instance of the DefaultCredentialsProvider using the default configuration.

Method Summary

Modifier and Type	Method	Description
static DefaultCredentialsProvider.Builder	builder()	Get a builder for defining a DefaultCredentialsProvider with custom configuration.
void	close()
AwsCredentials	getCredentials()	Returns AwsCredentials that can be used to authorize an AWS request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCredentialsProvider

public DefaultCredentialsProvider()

Create an instance of the DefaultCredentialsProvider using the default configuration. Configuration can be specified by creating an instance using the builder().

Method Detail

builder

public static DefaultCredentialsProvider.Builder builder()

Get a builder for defining a DefaultCredentialsProvider with custom configuration.

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