dsql/aws.sdk.kotlin.services.dsql/DsqlClient

DsqlClient

This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.

Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to acquire new insights for your business and customers.

Types

Builder

class Builder : AbstractSdkClientBuilder<DsqlClient.Config, DsqlClient.Config.Builder, DsqlClient>

Companion

object Companion : AbstractAwsSdkClientFactory<DsqlClient.Config, DsqlClient.Config.Builder, DsqlClient, DsqlClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: DsqlClient.Config

DsqlClient's configuration

Functions

createCluster

abstract suspend fun createCluster(input: CreateClusterRequest = CreateClusterRequest { }): CreateClusterResponse

The CreateCluster API allows you to create both single-region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.

deleteCluster

abstract suspend fun deleteCluster(input: DeleteClusterRequest): DeleteClusterResponse

Deletes a cluster in Amazon Aurora DSQL.

getCluster

abstract suspend fun getCluster(input: GetClusterRequest): GetClusterResponse

Retrieves information about a cluster.

getVpcEndpointServiceName

abstract suspend fun getVpcEndpointServiceName(input: GetVpcEndpointServiceNameRequest): GetVpcEndpointServiceNameResponse

Retrieves the VPC endpoint service name.

listClusters

abstract suspend fun listClusters(input: ListClustersRequest = ListClustersRequest { }): ListClustersResponse

Retrieves information about a list of clusters.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists all of the tags for a resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags a resource with a map of key and value pairs.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag from a resource.

updateCluster

abstract suspend fun updateCluster(input: UpdateClusterRequest): UpdateClusterResponse

The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.

Inherited functions

expect abstract fun close()

createCluster

inline suspend fun DsqlClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

deleteCluster

inline suspend fun DsqlClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

Deletes a cluster in Amazon Aurora DSQL.

getCluster

inline suspend fun DsqlClient.getCluster(crossinline block: GetClusterRequest.Builder.() -> Unit): GetClusterResponse

Retrieves information about a cluster.

getVpcEndpointServiceName

inline suspend fun DsqlClient.getVpcEndpointServiceName(crossinline block: GetVpcEndpointServiceNameRequest.Builder.() -> Unit): GetVpcEndpointServiceNameResponse

Retrieves the VPC endpoint service name.

listClusters

inline suspend fun DsqlClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

Retrieves information about a list of clusters.

listClustersPaginated

fun DsqlClient.listClustersPaginated(initialRequest: ListClustersRequest = ListClustersRequest { }): Flow<ListClustersResponse>

fun DsqlClient.listClustersPaginated(block: ListClustersRequest.Builder.() -> Unit): Flow<ListClustersResponse>

Paginate over ListClustersResponse results.

listTagsForResource

inline suspend fun DsqlClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all of the tags for a resource.

tagResource

inline suspend fun DsqlClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags a resource with a map of key and value pairs.

untagResource

inline suspend fun DsqlClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag from a resource.

updateCluster

inline suspend fun DsqlClient.updateCluster(crossinline block: UpdateClusterRequest.Builder.() -> Unit): UpdateClusterResponse

waitUntilClusterActive

suspend fun DsqlClient.waitUntilClusterActive(block: GetClusterRequest.Builder.() -> Unit): Outcome<GetClusterResponse>

suspend fun DsqlClient.waitUntilClusterActive(request: GetClusterRequest, retryStrategy: RetryStrategy? = null): Outcome<GetClusterResponse>

Wait until a Cluster is ACTIVE

waitUntilClusterNotExists

suspend fun DsqlClient.waitUntilClusterNotExists(block: GetClusterRequest.Builder.() -> Unit): Outcome<GetClusterResponse>

suspend fun DsqlClient.waitUntilClusterNotExists(request: GetClusterRequest, retryStrategy: RetryStrategy? = null): Outcome<GetClusterResponse>

Wait until a Cluster is gone

withConfig

fun DsqlClient.withConfig(block: DsqlClient.Config.Builder.() -> Unit): DsqlClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.