software.amazon.awssdk.auth.credentials

Class InstanceProfileCredentialsProvider

java.lang.Object

software.amazon.awssdk.auth.credentials.InstanceProfileCredentialsProvider

All Implemented Interfaces:

AutoCloseable, AwsCredentialsProvider, SdkAutoCloseable

public class InstanceProfileCredentialsProvider
extends Object

Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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.
void	close()
static InstanceProfileCredentialsProvider	create() Create a InstanceProfileCredentialsProvider with default values.
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

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

toString

public String toString()

Overrides:

toString in class Object

getCredentials

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

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable