dsql/aws.sdk.kotlin.services.dsql

Package-level declarations

Types

class DsqlAuthTokenGenerator(val credentialsProvider: CredentialsProvider = DefaultChainCredentialsProvider(), val signer: AwsSigner = DefaultAwsSigner, val clock: Clock = Clock.System)

Generates an IAM authentication token for use with DSQL databases

DsqlClient

interface DsqlClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createCluster

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

Creates a cluster in Amazon Aurora DSQL.

createMultiRegionClusters

inline suspend fun DsqlClient.createMultiRegionClusters(crossinline block: CreateMultiRegionClustersRequest.Builder.() -> Unit): CreateMultiRegionClustersResponse

Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

deleteCluster

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

Deletes a cluster in Amazon Aurora DSQL.

deleteMultiRegionClusters

inline suspend fun DsqlClient.deleteMultiRegionClusters(crossinline block: DeleteMultiRegionClustersRequest.Builder.() -> Unit): DeleteMultiRegionClustersResponse

Deletes a multi-Region 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.

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

Updates a cluster.

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.