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

Inherited functions

createCluster

inline suspend fun DsqlClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): 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

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

Deletes a cluster in Amazon Aurora DSQL.

deleteClusterPolicy

inline suspend fun DsqlClient.deleteClusterPolicy(crossinline block: DeleteClusterPolicyRequest.Builder.() -> Unit): DeleteClusterPolicyResponse

Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.

getCluster

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

Retrieves information about a cluster.

getClusterPolicy

inline suspend fun DsqlClient.getClusterPolicy(crossinline block: GetClusterPolicyRequest.Builder.() -> Unit): GetClusterPolicyResponse

Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the 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.

putClusterPolicy

inline suspend fun DsqlClient.putClusterPolicy(crossinline block: PutClusterPolicyRequest.Builder.() -> Unit): PutClusterPolicyResponse

Attaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals can perform actions on the cluster.

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

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.

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.