Package org.springframework.vault.authentication

Class AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder

Enclosing class:

AwsEc2AuthenticationOptions

public static class AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder
extends Object

Builder for AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

Method Summary

Modifier and Type	Method	Description
AwsEc2AuthenticationOptions	build()	Build a new AwsEc2AuthenticationOptions instance.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	identityDocumentUri(URI identityDocumentUri)	Configure the Identity Document URI.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	metadataTokenRequestUri(URI metadataTokenRequestUri)	Configure the Identity Metadata token request URI.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	metadataTokenTtl(Duration ttl)	Configure the Instance Service Metadata v2 Token TTL.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	nonce(AwsEc2AuthenticationOptions.Nonce nonce)	Configure a AwsEc2AuthenticationOptions.Nonce for login requests.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	path(String path)	Configure the mount path.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	role(@Nullable String role)	Configure the name of the role against which the login is being attempted.If role is not specified, then the login endpoint looks for a role bearing the name of the AMI ID of the EC2 instance that is trying to login.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	version(AwsEc2AuthenticationOptions.InstanceMetadataServiceVersion version)	Configure the Instance Service Metadata version.

Methods inherited from class java.lang.Object

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

Method Details

path

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder path(String path)

Configure the mount path.

Parameters:

path - must not be empty or null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

identityDocumentUri

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder identityDocumentUri(URI identityDocumentUri)

Configure the Identity Document URI.

Parameters:

identityDocumentUri - must not be null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

See Also:

• AwsEc2AuthenticationOptions.DEFAULT_PKCS7_IDENTITY_DOCUMENT_URI

role

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder role(@Nullable String role)

Configure the name of the role against which the login is being attempted.If role is not specified, then the login endpoint looks for a role bearing the name of the AMI ID of the EC2 instance that is trying to login.

Parameters:

role - may be empty or null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

nonce

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder nonce(AwsEc2AuthenticationOptions.Nonce nonce)

Configure a AwsEc2AuthenticationOptions.Nonce for login requests. Defaults to AwsEc2AuthenticationOptions.Nonce.generated().

Parameters:

nonce - must not be null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

Since:

1.1

metadataTokenTtl

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder metadataTokenTtl(Duration ttl)

Configure the Instance Service Metadata v2 Token TTL. Defaults to 1 minute.

Parameters:

ttl - must not be null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

Since:

3.2

metadataTokenRequestUri

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder metadataTokenRequestUri(URI metadataTokenRequestUri)

Configure the Identity Metadata token request URI.

Parameters:

metadataTokenRequestUri - must not be null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

Since:

3.2

See Also:

• AwsEc2AuthenticationOptions.DEFAULT_IMDSV2_TOKEN_URI

version

public AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder version(AwsEc2AuthenticationOptions.InstanceMetadataServiceVersion version)

Configure the Instance Service Metadata version. Defaults to AwsEc2AuthenticationOptions.InstanceMetadataServiceVersion.V1.

Parameters:

version - must not be null.

Returns:

this AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

Since:

3.2

build

public AwsEc2AuthenticationOptions build()

Build a new AwsEc2AuthenticationOptions instance.

Returns:

a new AwsEc2AuthenticationOptions.