Package software.amazon.awssdk.auth

Class ProfileCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.ProfileCredentialsProvider

All Implemented Interfaces:

AwsCredentialsProvider

public class ProfileCredentialsProvider
extends Object

Credentials provider based on AWS configuration profiles. This provider vends AWSCredentials from the profile configuration file for the default profile, or for a specific, named profile.

AWS credential profiles allow 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

See Also:

ProfilesConfigFile

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ProfileCredentialsProvider()	Create a ProfileCredentialsProvider using the default profile and configuration file.

Method Summary

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

ProfileCredentialsProvider

public ProfileCredentialsProvider()

Create a ProfileCredentialsProvider using the default profile and configuration file. Use builder() for defining a custom ProfileCredentialsProvider.

Method Detail

builder

public static ProfileCredentialsProvider.Builder builder()

Get a builder for creating a custom ProfileCredentialsProvider.

toString

public String toString()

Overrides:

toString in class Object

getCredentials

public final 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.