Interface DsqlClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface DsqlClient
extends AwsClient

Service client for accessing Amazon Aurora DSQL. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static DsqlClientBuilder	builder()	Create a builder that can be used to configure and create a DsqlClient.
static DsqlClient	create()	Create a DsqlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Deletes a cluster in Amazon Aurora DSQL.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes a cluster in Amazon Aurora DSQL.
default DeleteClusterPolicyResponse	deleteClusterPolicy(Consumer<DeleteClusterPolicyRequest.Builder> deleteClusterPolicyRequest)	Deletes the resource-based policy attached to a cluster.
default DeleteClusterPolicyResponse	deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest)	Deletes the resource-based policy attached to a cluster.
default GetClusterResponse	getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)	Retrieves information about a cluster.
default GetClusterResponse	getCluster(GetClusterRequest getClusterRequest)	Retrieves information about a cluster.
default GetClusterPolicyResponse	getClusterPolicy(Consumer<GetClusterPolicyRequest.Builder> getClusterPolicyRequest)	Retrieves the resource-based policy document attached to a cluster.
default GetClusterPolicyResponse	getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest)	Retrieves the resource-based policy document attached to a cluster.
default GetVpcEndpointServiceNameResponse	getVpcEndpointServiceName(Consumer<GetVpcEndpointServiceNameRequest.Builder> getVpcEndpointServiceNameRequest)	Retrieves the VPC endpoint service name.
default GetVpcEndpointServiceNameResponse	getVpcEndpointServiceName(GetVpcEndpointServiceNameRequest getVpcEndpointServiceNameRequest)	Retrieves the VPC endpoint service name.
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)	Retrieves information about a list of clusters.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest)	Retrieves information about a list of clusters.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all of the tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all of the tags for a resource.
default PutClusterPolicyResponse	putClusterPolicy(Consumer<PutClusterPolicyRequest.Builder> putClusterPolicyRequest)	Attaches a resource-based policy to a cluster.
default PutClusterPolicyResponse	putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest)	Attaches a resource-based policy to a cluster.
default DsqlServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tags a resource with a map of key and value pairs.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tags a resource with a map of key and value pairs.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag from a resource.
default UpdateClusterResponse	updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)	The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations.
default UpdateClusterResponse	updateCluster(UpdateClusterRequest updateClusterRequest)	The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations.
default DsqlUtilities	utilities()	Creates an instance of DsqlUtilities object with the configuration set on this client.
default DsqlWaiter	waiter()	Create an instance of DsqlWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.

Required permissions

dsql:CreateCluster

Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:TagResource

Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:AddPeerCluster

When specifying multiRegionProperties.clusters, permission to add peer clusters.

Resources:

• Local cluster: arn:aws:dsql:region:account-id:cluster/*

• Each peer cluster: exact ARN of each specified peer cluster

dsql:PutWitnessRegion

When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

• The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.

Required permissions

dsql:CreateCluster

Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:TagResource

Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:AddPeerCluster

When specifying multiRegionProperties.clusters, permission to add peer clusters.

Resources:

• Local cluster: arn:aws:dsql:region:account-id:cluster/*

• Each peer cluster: exact ARN of each specified peer cluster

dsql:PutWitnessRegion

When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

• The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

Deletes a cluster in Amazon Aurora DSQL.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

Deletes a cluster in Amazon Aurora DSQL.

This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteClusterPolicy

default DeleteClusterPolicyResponse deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest)
                                                 throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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

Parameters:

deleteClusterPolicyRequest -

Returns:

Result of the DeleteClusterPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteClusterPolicy

default DeleteClusterPolicyResponse deleteClusterPolicy(Consumer<DeleteClusterPolicyRequest.Builder> deleteClusterPolicyRequest)
                                                 throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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

This is a convenience which creates an instance of the DeleteClusterPolicyRequest.Builder avoiding the need to create one manually via DeleteClusterPolicyRequest.builder()

Parameters:

deleteClusterPolicyRequest - A Consumer that will call methods on DeleteClusterPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteClusterPolicy operation returned by the service.

See Also:

• AWS API Documentation

getCluster

default GetClusterResponse getCluster(GetClusterRequest getClusterRequest)
                               throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves information about a cluster.

Parameters:

getClusterRequest -

Returns:

Result of the GetCluster operation returned by the service.

See Also:

• AWS API Documentation

getCluster

default GetClusterResponse getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)
                               throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves information about a cluster.

This is a convenience which creates an instance of the GetClusterRequest.Builder avoiding the need to create one manually via GetClusterRequest.builder()

Parameters:

getClusterRequest - A Consumer that will call methods on GetClusterRequest.Builder to create a request.

Returns:

Result of the GetCluster operation returned by the service.

See Also:

• AWS API Documentation

getClusterPolicy

default GetClusterPolicyResponse getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest)
                                           throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.

Parameters:

getClusterPolicyRequest -

Returns:

Result of the GetClusterPolicy operation returned by the service.

See Also:

• AWS API Documentation

getClusterPolicy

default GetClusterPolicyResponse getClusterPolicy(Consumer<GetClusterPolicyRequest.Builder> getClusterPolicyRequest)
                                           throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.

This is a convenience which creates an instance of the GetClusterPolicyRequest.Builder avoiding the need to create one manually via GetClusterPolicyRequest.builder()

Parameters:

getClusterPolicyRequest - A Consumer that will call methods on GetClusterPolicyRequest.Builder to create a request.

Returns:

Result of the GetClusterPolicy operation returned by the service.

See Also:

• AWS API Documentation

getVpcEndpointServiceName

default GetVpcEndpointServiceNameResponse getVpcEndpointServiceName(GetVpcEndpointServiceNameRequest getVpcEndpointServiceNameRequest)
                                                             throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves the VPC endpoint service name.

Parameters:

getVpcEndpointServiceNameRequest -

Returns:

Result of the GetVpcEndpointServiceName operation returned by the service.

See Also:

• AWS API Documentation

getVpcEndpointServiceName

default GetVpcEndpointServiceNameResponse getVpcEndpointServiceName(Consumer<GetVpcEndpointServiceNameRequest.Builder> getVpcEndpointServiceNameRequest)
                                                             throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves the VPC endpoint service name.

This is a convenience which creates an instance of the GetVpcEndpointServiceNameRequest.Builder avoiding the need to create one manually via GetVpcEndpointServiceNameRequest.builder()

Parameters:

getVpcEndpointServiceNameRequest - A Consumer that will call methods on GetVpcEndpointServiceNameRequest.Builder to create a request.

Returns:

Result of the GetVpcEndpointServiceName operation returned by the service.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves information about a list of clusters.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Retrieves information about a list of clusters.

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest)
                                            throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.dsql.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                            throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

This is a variant of listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.dsql.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.dsql.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.dsql.model.ListClustersRequest) operation.

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Lists all of the tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Lists all of the tags for a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putClusterPolicy

default PutClusterPolicyResponse putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest)
                                           throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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.

Parameters:

putClusterPolicyRequest -

Returns:

Result of the PutClusterPolicy operation returned by the service.

See Also:

• AWS API Documentation

putClusterPolicy

default PutClusterPolicyResponse putClusterPolicy(Consumer<PutClusterPolicyRequest.Builder> putClusterPolicyRequest)
                                           throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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.

This is a convenience which creates an instance of the PutClusterPolicyRequest.Builder avoiding the need to create one manually via PutClusterPolicyRequest.builder()

Parameters:

putClusterPolicyRequest - A Consumer that will call methods on PutClusterPolicyRequest.Builder to create a request.

Returns:

Result of the PutClusterPolicy operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ServiceQuotaExceededException,
ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

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

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Removes a tag from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ThrottlingException,
AccessDeniedException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DsqlException

Removes a tag from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest)
                                     throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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.

Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.

Required permissions

dsql:UpdateCluster

Permission to update a DSQL cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:GetCluster

Permission to retrieve cluster information.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:AddPeerCluster

Permission to add peer clusters.

Resources:

• Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id

• Each peer cluster: exact ARN of each specified peer cluster

dsql:RemovePeerCluster

Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Resources: arn:aws:dsql:*:account-id:cluster/*

dsql:PutWitnessRegion

Permission to set a witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

Condition Keys: dsql:WitnessRegion (matching the specified witness Region)

This permission is checked both in the cluster Region and in the witness Region.

• The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

• When updating clusters with peer relationships, permissions are checked for both adding and removing peers.

• The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Parameters:

updateClusterRequest -

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

• AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
                                     throws ThrottlingException,
ValidationException,
AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
DsqlException

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.

Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.

Required permissions

dsql:UpdateCluster

Permission to update a DSQL cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:GetCluster

Permission to retrieve cluster information.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:AddPeerCluster

Permission to add peer clusters.

Resources:

• Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id

• Each peer cluster: exact ARN of each specified peer cluster

dsql:RemovePeerCluster

Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Resources: arn:aws:dsql:*:account-id:cluster/*

dsql:PutWitnessRegion

Permission to set a witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

Condition Keys: dsql:WitnessRegion (matching the specified witness Region)

This permission is checked both in the cluster Region and in the witness Region.

• The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

• When updating clusters with peer relationships, permissions are checked for both adding and removing peers.

• The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

This is a convenience which creates an instance of the UpdateClusterRequest.Builder avoiding the need to create one manually via UpdateClusterRequest.builder()

Parameters:

updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

• AWS API Documentation

utilities

default DsqlUtilities utilities()

Creates an instance of DsqlUtilities object with the configuration set on this client.

waiter

default DsqlWaiter waiter()

Create an instance of DsqlWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of DsqlWaiter

create

static DsqlClient create()

Create a DsqlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DsqlClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DsqlServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration