Interface GenerateAuthTokenRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>, SdkBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>

Enclosing class:

GenerateAuthTokenRequest

@SdkPublicApi
@NotThreadSafe
public static interface GenerateAuthTokenRequest.Builder
extends CopyableBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>

A builder for a GenerateAuthTokenRequest, created with GenerateAuthTokenRequest.builder().

Method Summary

Modifier and Type	Method	Description
GenerateAuthTokenRequest	build()	An immutable object that is created from the properties that have been set on the builder.
default GenerateAuthTokenRequest.Builder	credentialsProvider(AwsCredentialsProvider credentialsProvider)	The credentials provider to sign the IAM auth request with.
default GenerateAuthTokenRequest.Builder	credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider)	The credentials provider to sign the IAM auth request with.
GenerateAuthTokenRequest.Builder	expiresIn(Duration expiresIn)	The duration a token is valid for.
GenerateAuthTokenRequest.Builder	hostname(String endpoint)	The hostname of the database to connect to
GenerateAuthTokenRequest.Builder	region(Region region)	The region the database is hosted in.

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

copy

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

applyMutation

Method Details

hostname

GenerateAuthTokenRequest.Builder hostname(String endpoint)

The hostname of the database to connect to

Returns:

This object for method chaining

region

GenerateAuthTokenRequest.Builder region(Region region)

The region the database is hosted in. If specified, takes precedence over the value specified in DsqlUtilities.Builder.region(Region)

Returns:

This object for method chaining

expiresIn

GenerateAuthTokenRequest.Builder expiresIn(Duration expiresIn)

The duration a token is valid for.

Returns:

This object for method chaining

credentialsProvider

default GenerateAuthTokenRequest.Builder credentialsProvider(AwsCredentialsProvider credentialsProvider)

The credentials provider to sign the IAM auth request with. If specified, takes precedence over the value specified in

invalid @link

{@link DsqlUtilities.Builder#credentialsProvider)

}}

Returns:

This object for method chaining

credentialsProvider

default GenerateAuthTokenRequest.Builder credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider)

The credentials provider to sign the IAM auth request with. If specified, takes precedence over the value specified in DsqlUtilities.Builder.credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider)}

Returns:

This object for method chaining

build

GenerateAuthTokenRequest build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>

Returns:

an instance of T