Class ProfileCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider

All Implemented Interfaces:

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

public final class ProfileCredentialsProvider
extends Object
implements AwsCredentialsProvider, SdkAutoCloseable, ToCopyableBuilder<ProfileCredentialsProvider.Builder,ProfileCredentialsProvider>

Credentials provider based on AWS configuration profiles. This loads credentials from a ProfileFile, allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI.

See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html

If this credentials provider is loading assume-role credentials from STS, it should be cleaned up with close() if it is no longer being used.

See Also:

• ProfileFile

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProfileCredentialsProvider.Builder	A builder for creating a custom ProfileCredentialsProvider.

Method Summary

Modifier and Type	Method	Description
static ProfileCredentialsProvider.Builder	builder()	Get a builder for creating a custom ProfileCredentialsProvider.
void	close()
static ProfileCredentialsProvider	create()	Create a ProfileCredentialsProvider using the ProfileFile.defaultProfileFile() and default profile name.
static ProfileCredentialsProvider	create(String profileName)	Create a ProfileCredentialsProvider using the given profile name and ProfileFile.defaultProfileFile().
AwsCredentials	resolveCredentials()	Returns AwsCredentials that can be used to authorize an AWS request.
ProfileCredentialsProvider.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

equals, 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 Details

create

public static ProfileCredentialsProvider create()

Create a ProfileCredentialsProvider using the ProfileFile.defaultProfileFile() and default profile name. Use builder() for defining a custom ProfileCredentialsProvider.

create

public static ProfileCredentialsProvider create(String profileName)

Create a ProfileCredentialsProvider using the given profile name and ProfileFile.defaultProfileFile(). Use builder() for defining a custom ProfileCredentialsProvider.

Parameters:

profileName - the name of the profile to use from the ProfileFile.defaultProfileFile()

builder

public static ProfileCredentialsProvider.Builder builder()

Get a builder for creating a custom ProfileCredentialsProvider.

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.

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

toBuilder

public ProfileCredentialsProvider.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ProfileCredentialsProvider.Builder,ProfileCredentialsProvider>

Returns:

a builder for type T