software.amazon.awssdk.services.rds

Interface RdsUtilities

public interface RdsUtilities

Utilities for working with RDS. An instance of this class can be created by:

1) Using the low-level client RdsClient.utilities() (or RdsAsyncClient.utilities()} method. This is recommended as SDK will use the same configuration from the RdsClient object to create the RdsUtilities object.

 RdsClient rdsClient = RdsClient.create();
 RdsUtilities utilities = rdsClient.utilities();
 

2) Directly using the builder() method.

 RdsUtilities utilities = RdsUtilities.builder()
  .credentialsProvider(DefaultCredentialsProvider.create())
  .region(Region.US_WEST_2)
  .build()
 

Note: This class does not make network calls.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RdsUtilities.Builder Builder for creating an instance of RdsUtilities.

Method Summary

Modifier and Type	Method and Description
static RdsUtilities.Builder	builder() Create a builder that can be used to configure and create a RdsUtilities.
default String	generateAuthenticationToken(Consumer<GenerateAuthenticationTokenRequest.Builder> request) Generates an authorization tokens for IAM authentication to an RDS database.
default String	generateAuthenticationToken(GenerateAuthenticationTokenRequest request) Generates an authorization tokens for IAM authentication to an RDS database.

Method Detail

builder

static RdsUtilities.Builder builder()

Create a builder that can be used to configure and create a RdsUtilities.

generateAuthenticationToken

default String generateAuthenticationToken(Consumer<GenerateAuthenticationTokenRequest.Builder> request)

Generates an authorization tokens for IAM authentication to an RDS database.

Parameters:

request - The request used to generate the auth token

Returns:

String to use as the RDS auth token

Throws:

IllegalArgumentException - if the required parameters are not valid

generateAuthenticationToken

default String generateAuthenticationToken(GenerateAuthenticationTokenRequest request)

Generates an authorization tokens for IAM authentication to an RDS database.

Parameters:

request - The request used to generate the auth token

Returns:

String to use as the RDS auth token

Throws:

IllegalArgumentException - if the required parameters are not valid