Class InstanceProfileCredentialsProvider
java.lang.Object
software.amazon.awssdk.auth.credentials.InstanceProfileCredentialsProvider
- All Implemented Interfaces:
AutoCloseable
,AwsCredentialsProvider
,HttpCredentialsProvider
,IdentityProvider<AwsCredentialsIdentity>
,ToCopyableBuilder<InstanceProfileCredentialsProvider.Builder,
,InstanceProfileCredentialsProvider> SdkAutoCloseable
public final class InstanceProfileCredentialsProvider
extends Object
implements HttpCredentialsProvider, ToCopyableBuilder<InstanceProfileCredentialsProvider.Builder,InstanceProfileCredentialsProvider>
Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.
If SdkSystemSetting.AWS_EC2_METADATA_DISABLED
is set to true, it will not try to load
credentials from EC2 metadata service and will return null.
If SdkSystemSetting.AWS_EC2_METADATA_V1_DISABLED
or ProfileProperty.EC2_METADATA_V1_DISABLED
is set to true, credentials will only be loaded from EC2 metadata service if a token is successfully retrieved -
fallback to load credentials without a token will be disabled.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
A builder for creating a custom aInstanceProfileCredentialsProvider
. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder for creating aInstanceProfileCredentialsProvider
.void
close()
create()
Create aInstanceProfileCredentialsProvider
with default values.ReturnsAwsCredentials
that can be used to authorize an AWS request.Take this object and create a builder that contains all of the current property values of this object.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
-
builder
Create a builder for creating aInstanceProfileCredentialsProvider
. -
create
Create aInstanceProfileCredentialsProvider
with default values.- Returns:
- a
InstanceProfileCredentialsProvider
-
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()Description copied from interface:SdkAutoCloseable
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSdkAutoCloseable
-
toString
-
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 interfaceToCopyableBuilder<InstanceProfileCredentialsProvider.Builder,
InstanceProfileCredentialsProvider> - Returns:
- a builder for type T
-