Package software.amazon.awssdk.auth.credentials

Interface InstanceProfileCredentialsProvider.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstanceProfileCredentialsProvider.Builder,InstanceProfileCredentialsProvider>, HttpCredentialsProvider.Builder<InstanceProfileCredentialsProvider,InstanceProfileCredentialsProvider.Builder>, SdkBuilder<InstanceProfileCredentialsProvider.Builder,InstanceProfileCredentialsProvider>

Enclosing class:

InstanceProfileCredentialsProvider

public static interface InstanceProfileCredentialsProvider.Builder
extends HttpCredentialsProvider.Builder<InstanceProfileCredentialsProvider,InstanceProfileCredentialsProvider.Builder>, CopyableBuilder<InstanceProfileCredentialsProvider.Builder,InstanceProfileCredentialsProvider>

A builder for creating a custom a InstanceProfileCredentialsProvider.

Method Summary

Modifier and Type	Method	Description
InstanceProfileCredentialsProvider	build()	Build a InstanceProfileCredentialsProvider from the provided configuration.
InstanceProfileCredentialsProvider.Builder	profileFile(Supplier<ProfileFile> profileFileSupplier)	Define the mechanism for loading profile files.
InstanceProfileCredentialsProvider.Builder	profileFile(ProfileFile profileFile)	Configure the profile file used for loading IMDS-related configuration, like the endpoint mode (IPv4 vs IPv6).
InstanceProfileCredentialsProvider.Builder	profileName(String profileName)	Configure the profile name used for loading IMDS-related configuration, like the endpoint mode (IPv4 vs IPv6).
InstanceProfileCredentialsProvider.Builder	staleTime(Duration duration)	Configure the amount of time before the moment of expiration of credentials for which to consider the credentials to be stale.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.auth.credentials.HttpCredentialsProvider.Builder

asyncCredentialUpdateEnabled, asyncThreadName, endpoint, sourceChain

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Method Detail

profileFile

InstanceProfileCredentialsProvider.Builder profileFile(ProfileFile profileFile)

Configure the profile file used for loading IMDS-related configuration, like the endpoint mode (IPv4 vs IPv6).

By default, ProfileFile.defaultProfileFile() is used.

See Also:

profileFile(Supplier)

profileFile

InstanceProfileCredentialsProvider.Builder profileFile(Supplier<ProfileFile> profileFileSupplier)

Define the mechanism for loading profile files.

Parameters:

profileFileSupplier - Supplier interface for generating a ProfileFile instance.

See Also:

profileFile(ProfileFile)

profileName

InstanceProfileCredentialsProvider.Builder profileName(String profileName)

Configure the profile name used for loading IMDS-related configuration, like the endpoint mode (IPv4 vs IPv6).

By default, ProfileFileSystemSetting.AWS_PROFILE is used.

staleTime

InstanceProfileCredentialsProvider.Builder staleTime(Duration duration)

Configure the amount of time before the moment of expiration of credentials for which to consider the credentials to be stale. A higher value can lead to a higher rate of request being made to the Amazon EC2 Instance Metadata Service. The default is 1 sec.

Increasing this value to a higher value (10s or more) may help with situations where a higher load on the instance metadata service causes it to return 503s error, for which the SDK may not be able to recover fast enough and returns expired credentials.

Parameters:

duration - the amount of time before expiration for when to consider the credentials to be stale and need refresh

build

InstanceProfileCredentialsProvider build()

Build a InstanceProfileCredentialsProvider from the provided configuration.

Specified by:

build in interface Buildable

Specified by:

build in interface HttpCredentialsProvider.Builder<InstanceProfileCredentialsProvider,InstanceProfileCredentialsProvider.Builder>

Specified by:

build in interface SdkBuilder<InstanceProfileCredentialsProvider.Builder,InstanceProfileCredentialsProvider>