Package software.amazon.awssdk.auth.credentials

Class DefaultCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, IdentityProvider<AwsCredentialsIdentity>, ToCopyableBuilder<DefaultCredentialsProvider.Builder,DefaultCredentialsProvider>, SdkAutoCloseable

@SdkPublicApi
public final class DefaultCredentialsProvider
extends Object
implements AwsCredentialsProvider, SdkAutoCloseable, ToCopyableBuilder<DefaultCredentialsProvider.Builder,DefaultCredentialsProvider>

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

1. Java System Properties - aws.accessKeyId and aws.secretAccessKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Web Identity Token credentials from system properties or environment variables
4. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
5. 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,
6. Instance profile credentials delivered through the Amazon EC2 metadata service

See Also:

SystemPropertyCredentialsProvider, EnvironmentVariableCredentialsProvider, ProfileCredentialsProvider, WebIdentityTokenFileCredentialsProvider, ContainerCredentialsProvider, InstanceProfileCredentialsProvider

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DefaultCredentialsProvider.Builder	builder()	Get a builder for defining a DefaultCredentialsProvider with custom configuration.
void	close()
static DefaultCredentialsProvider	create()	Deprecated. The create() method that returns a singleton instance which can cause issues if one client closes the provider while others are still using it.
AwsCredentials	resolveCredentials()	Returns AwsCredentials that can be used to authorize an AWS request.
DefaultCredentialsProvider.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.auth.credentials.AwsCredentialsProvider

identityType, resolveIdentity

Methods inherited from interface software.amazon.awssdk.identity.spi.IdentityProvider

resolveIdentity, resolveIdentity

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

create

@Deprecated
public static DefaultCredentialsProvider create()

Deprecated.

The create() method that returns a singleton instance which can cause issues if one client closes the provider while others are still using it. Use builder().build() to create independent instances, which is the safer approach and recommended for most use cases.

Returns the singleton instance of the DefaultCredentialsProvider using the default configuration. Configuration can be specified by creating an instance using the builder(). If you want to create a new instance, use builder() instead.

builder

public static DefaultCredentialsProvider.Builder builder()

Get a builder for defining a DefaultCredentialsProvider with custom configuration.

resolveCredentials

public AwsCredentials resolveCredentials()

Description copied from interface: AwsCredentialsProvider

Returns AwsCredentials that can be used to authorize an AWS request. Each implementation of AWSCredentialsProvider can choose 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:

resolveCredentials 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

Specified by:

close in interface SdkAutoCloseable

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public DefaultCredentialsProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultCredentialsProvider.Builder,DefaultCredentialsProvider>