Class GenerateAuthTokenRequest

java.lang.Object

software.amazon.awssdk.services.dsql.model.GenerateAuthTokenRequest

All Implemented Interfaces:

ToCopyableBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>

@SdkPublicApi
public final class GenerateAuthTokenRequest
extends Object
implements ToCopyableBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>

Input parameters for generating an authentication token for IAM database authentication for DSQL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerateAuthTokenRequest.Builder	A builder for a GenerateAuthTokenRequest, created with builder().

Method Summary

Modifier and Type	Method	Description
static GenerateAuthTokenRequest.Builder	builder()	Creates a builder for DsqlUtilities.
IdentityProvider<? extends AwsCredentialsIdentity>	credentialsIdentityProvider()
AwsCredentialsProvider	credentialsProvider()
boolean	equals(Object o)
Duration	expiresIn()
int	hashCode()
String	hostname()
Region	region()
GenerateAuthTokenRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hostname

public String hostname()

Returns:

The hostname of the database to connect to

expiresIn

public Duration expiresIn()

Returns:

The token expiry duration

region

public Region region()

Returns:

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

credentialsProvider

public AwsCredentialsProvider credentialsProvider()

Returns:

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)}

credentialsIdentityProvider

public IdentityProvider<? extends AwsCredentialsIdentity> credentialsIdentityProvider()

Returns:

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

toBuilder

public GenerateAuthTokenRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GenerateAuthTokenRequest.Builder,GenerateAuthTokenRequest>

Returns:

a builder for type T

builder

public static GenerateAuthTokenRequest.Builder builder()

Creates a builder for DsqlUtilities.