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 and Description
AwsEc2AuthenticationOptions	build() Build a new AwsEc2AuthenticationOptions instance.
AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder	identityDocumentUri(URI identityDocumentUri) Configure the Identity Document URI.
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(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.

Methods inherited from class java.lang.Object

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

Method Detail

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

build

public AwsEc2AuthenticationOptions build()

Build a new AwsEc2AuthenticationOptions instance.

Returns:

a new AwsEc2AuthenticationOptions.