software.amazon.awssdk.auth.credentials

Class InstanceProfileCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.HttpCredentialsProvider

software.amazon.awssdk.auth.credentials.InstanceProfileCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

public final class InstanceProfileCredentialsProvider
extends HttpCredentialsProvider

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.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static InstanceProfileCredentialsProvider.Builder	builder() Create a builder for creating a InstanceProfileCredentialsProvider.
static InstanceProfileCredentialsProvider	create() Create a InstanceProfileCredentialsProvider with default values.
protected ResourcesEndpointProvider	getCredentialsEndpointProvider()
protected boolean	isLocalCredentialLoadingDisabled() Can be overridden by subclass to decide whether loading credential is disabled or not.
String	toString()

Methods inherited from class software.amazon.awssdk.auth.credentials.HttpCredentialsProvider

close, resolveCredentials

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getCredentialsEndpointProvider

protected ResourcesEndpointProvider getCredentialsEndpointProvider()

Specified by:

getCredentialsEndpointProvider in class HttpCredentialsProvider

isLocalCredentialLoadingDisabled

protected boolean isLocalCredentialLoadingDisabled()

Description copied from class: HttpCredentialsProvider

Can be overridden by subclass to decide whether loading credential is disabled or not.

Overrides:

isLocalCredentialLoadingDisabled in class HttpCredentialsProvider

Returns:

whether loading credential from local endpoint is disabled.

toString

public String toString()

Overrides:

toString in class Object