Package software.amazon.awssdk.auth.credentials

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

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InstanceProfileCredentialsProvider.Builder	builder()	Create a builder for creating a InstanceProfileCredentialsProvider.
void	close()
static InstanceProfileCredentialsProvider	create()	Create a InstanceProfileCredentialsProvider with default values.
AwsCredentials	resolveCredentials()	Returns AwsCredentials that can be used to authorize an AWS request.
InstanceProfileCredentialsProvider.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

builder

public static InstanceProfileCredentialsProvider.Builder builder()

Create a builder for creating a InstanceProfileCredentialsProvider.

create

public static InstanceProfileCredentialsProvider create()

Create a InstanceProfileCredentialsProvider with default values.

Returns:

a InstanceProfileCredentialsProvider

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 InstanceProfileCredentialsProvider.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceProfileCredentialsProvider.Builder,InstanceProfileCredentialsProvider>