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 aProfileFile
, 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 customProfileCredentialsProvider
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ProfileCredentialsProvider.Builder
builder()
Get a builder for creating a customProfileCredentialsProvider
.void
close()
static ProfileCredentialsProvider
create()
Create aProfileCredentialsProvider
using theProfileFile.defaultProfileFile()
and default profile name.static ProfileCredentialsProvider
create(String profileName)
Create aProfileCredentialsProvider
using the given profile name andProfileFile.defaultProfileFile()
.AwsCredentials
resolveCredentials()
ReturnsAwsCredentials
that can be used to authorize an AWS request.ProfileCredentialsProvider.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
public static ProfileCredentialsProvider create()
Create aProfileCredentialsProvider
using theProfileFile.defaultProfileFile()
and default profile name. Usebuilder()
for defining a customProfileCredentialsProvider
.
-
create
public static ProfileCredentialsProvider create(String profileName)
Create aProfileCredentialsProvider
using the given profile name andProfileFile.defaultProfileFile()
. Usebuilder()
for defining a customProfileCredentialsProvider
.- Parameters:
profileName
- the name of the profile to use from theProfileFile.defaultProfileFile()
-
builder
public static ProfileCredentialsProvider.Builder builder()
Get a builder for creating a customProfileCredentialsProvider
.
-
resolveCredentials
public AwsCredentials resolveCredentials()
Description copied from interface:AwsCredentialsProvider
ReturnsAwsCredentials
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 interfaceAwsCredentialsProvider
- Returns:
- AwsCredentials which the caller can use to authorize an AWS request.
-
close
public void close()
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSdkAutoCloseable
-
toBuilder
public ProfileCredentialsProvider.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProfileCredentialsProvider.Builder,ProfileCredentialsProvider>
-
-