Package org.springframework.vault.authentication

Class AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder

Enclosing class:

AwsIamAuthenticationOptions

public static class AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder
extends Object

Builder for AwsIamAuthenticationOptions.

Method Summary

Modifier and Type	Method	Description
AwsIamAuthenticationOptions	build()	Build a new AwsIamAuthenticationOptions instance.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	credentials(software.amazon.awssdk.auth.credentials.AwsCredentials credentials)	Configure static AWS credentials, required to calculate the signature.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)	Configure an AwsCredentialsProvider, required to calculate the signature.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	endpointUri(URI endpointUri)	Configure an endpoint URI of the STS API, defaults to https://sts.amazonaws.com/.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	path(String path)	Configure the mount path, defaults to aws.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	region(software.amazon.awssdk.regions.Region region)	Configure a Region, used for computing the signature.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	regionProvider(software.amazon.awssdk.regions.providers.AwsRegionProvider regionProvider)	Configure an AwsRegionProvider, required to calculate the region to be used for computing the signature.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	role(String role)	Configure the name of the role against which the login is being attempted.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	serverId(String serverId)	Configure a server name (used for Vault-AWS-IAM-Server-ID) that is included in the signature to mitigate the risk of replay attacks.
AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder	serverName(String serverName)	Configure a server name that is included in the signature to mitigate the risk of replay attacks.

Methods inherited from class java.lang.Object

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

Method Details

path

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder path(String path)

Configure the mount path, defaults to aws.

Parameters:

path - must not be empty or null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

credentials

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder credentials(software.amazon.awssdk.auth.credentials.AwsCredentials credentials)

Configure static AWS credentials, required to calculate the signature. Either use static credentials or provide a credentials provider.

Parameters:

credentials - must not be null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

See Also:

• credentialsProvider(AwsCredentialsProvider)

credentialsProvider

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)

Configure an AwsCredentialsProvider, required to calculate the signature. Alternatively, configure static credentials.

Parameters:

credentialsProvider - must not be null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

See Also:

• credentials(AwsCredentials)

region

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder region(software.amazon.awssdk.regions.Region region)

Configure a Region, used for computing the signature.

Parameters:

region - must not be null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

Since:

3.0.2

regionProvider

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder regionProvider(software.amazon.awssdk.regions.providers.AwsRegionProvider regionProvider)

Configure an AwsRegionProvider, required to calculate the region to be used for computing the signature.

Parameters:

regionProvider - must not be null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

Since:

3.0

role

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder role(String role)

Configure the name of the role against which the login is being attempted. If role is not specified, the friendly name (i.e., role name or username) of the IAM principal authenticated. If a matching role is not found, login fails.

Parameters:

role - must not be empty or null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

serverId

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder serverId(String serverId)

Configure a server name (used for Vault-AWS-IAM-Server-ID) that is included in the signature to mitigate the risk of replay attacks. Preferably use the Vault server DNS name.

Parameters:

serverId - must not be null or empty.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

Since:

2.1

serverName

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder serverName(String serverName)

Configure a server name that is included in the signature to mitigate the risk of replay attacks. Preferably use the Vault server DNS name.

Parameters:

serverName - must not be null or empty.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

endpointUri

public AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder endpointUri(URI endpointUri)

Configure an endpoint URI of the STS API, defaults to https://sts.amazonaws.com/.

Parameters:

endpointUri - must not be null.

Returns:

this AwsIamAuthenticationOptions.AwsIamAuthenticationOptionsBuilder.

build

public AwsIamAuthenticationOptions build()

Build a new AwsIamAuthenticationOptions instance.

Returns:

a new AwsIamAuthenticationOptions.