CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions to use this operation.

Permission to create a cluster.

dsql:CreateCluster

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

Permission to add tags to a resource.

dsql:TagResource

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

Permission to configure multi-region properties for a cluster.

dsql:PutMultiRegionProperties

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

When specifying multiRegionProperties.clusters.

dsql:AddPeerCluster

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

When specifying multiRegionProperties.witnessRegion.

dsql:PutWitnessRegion

Permission to set a witness region.

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

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

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

Parameter Syntax

$result = $client->createCluster([
    'clientToken' => '<string>',
    'deletionProtectionEnabled' => true || false,
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'deletionProtectionEnabled' => true || false,
    'identifier' => '<string>',
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
]

Result Details

Errors

ServiceQuotaExceededException:

The service limit was exceeded.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

The submitted action has conflicts.

Examples

Example 1: Create Cluster

$result = $client->createCluster([
    'deletionProtectionEnabled' => ,
    'tags' => [
        'MyKey' => 'MyValue',
    ],
]);

CreateMultiRegionClusters

$result = $client->createMultiRegionClusters([/* ... */]);
$promise = $client->createMultiRegionClustersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMultiRegionClusters([
    'clientToken' => '<string>',
    'clusterProperties' => [
        '<Region>' => [
            'deletionProtectionEnabled' => true || false,
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'linkedRegionList' => ['<string>', ...], // REQUIRED
    'witnessRegion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'linkedClusterArns' => ['<string>', ...],
]

Result Details

Errors

ServiceQuotaExceededException:

The service limit was exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

The submitted action has conflicts.

Examples

Example 1: Create Multi Region Clusters

$result = $client->createMultiRegionClusters([
    'linkedRegionList' => [
        'us-east-1',
        'us-east-2',
    ],
    'witnessRegion' => 'us-west-2',
]);

Result syntax:

[
    'linkedClusterArns' => [
        'arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrstu12345',
        'arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcde54321',
    ],
]

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes a cluster in Amazon Aurora DSQL.

Parameter Syntax

$result = $client->deleteCluster([
    'clientToken' => '<string>',
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'deletionProtectionEnabled' => true || false,
    'identifier' => '<string>',
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

Examples

Example 1: Delete Cluster

$result = $client->deleteCluster([
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

DeleteMultiRegionClusters

$result = $client->deleteMultiRegionClusters([/* ... */]);
$promise = $client->deleteMultiRegionClustersAsync([/* ... */]);

Deletes a multi-Region cluster in Amazon Aurora DSQL.

Parameter Syntax

$result = $client->deleteMultiRegionClusters([
    'clientToken' => '<string>',
    'linkedClusterArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

Examples

Example 1: Delete Multi Region Clusters

$result = $client->deleteMultiRegionClusters([
    'linkedClusterArns' => [
        'arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrstu12345',
        'arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcde54321',
    ],
]);

GetCluster

$result = $client->getCluster([/* ... */]);
$promise = $client->getClusterAsync([/* ... */]);

Retrieves information about a cluster.

Parameter Syntax

$result = $client->getCluster([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'deletionProtectionEnabled' => true || false,
    'identifier' => '<string>',
    'linkedClusterArns' => ['<string>', ...],
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
    'tags' => ['<string>', ...],
    'witnessRegion' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

Examples

Example 1: Get Cluster

$result = $client->getCluster([
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

GetVpcEndpointServiceName

$result = $client->getVpcEndpointServiceName([/* ... */]);
$promise = $client->getVpcEndpointServiceNameAsync([/* ... */]);

Retrieves the VPC endpoint service name.

Parameter Syntax

$result = $client->getVpcEndpointServiceName([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

Examples

Example 1: Get VPC Endpoint Service Name

$result = $client->getVpcEndpointServiceName([
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Retrieves information about a list of clusters.

Parameter Syntax

$result = $client->listClusters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'clusters' => [
        [
            'arn' => '<string>',
            'identifier' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

Examples

Example 1: List Clusters

$result = $client->listClusters([
    'maxResults' => 20,
]);

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all of the tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

Examples

Example 1: List Tags For Resource

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e',
]);

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

The service limit was exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

Examples

Example 1: Tag Resource

$result = $client->tagResource([
    'resourceArn' => 'arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e',
    'tags' => [
        'MyKey' => 'MyValue',
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

Examples

Example 1: Untag Resource

$result = $client->untagResource([
    'resourceArn' => 'arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e',
    'tagKeys' => [
        'MyKeyA',
        'MyKeyB',
    ],
]);

UpdateCluster

$result = $client->updateCluster([/* ... */]);
$promise = $client->updateClusterAsync([/* ... */]);

Updates a cluster.

Example IAM Policy for Multi-Region Operations

The following IAM policy grants permissions for multi-Region operations.

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

Parameter Syntax

$result = $client->updateCluster([
    'clientToken' => '<string>',
    'deletionProtectionEnabled' => true || false,
    'identifier' => '<string>', // REQUIRED
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'deletionProtectionEnabled' => true || false,
    'identifier' => '<string>',
    'linkedClusterArns' => ['<string>', ...],
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
    'witnessRegion' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input failed to satisfy the constraints specified by an Amazon Web Services service.

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource could not be found.

ConflictException:

The submitted action has conflicts.

Examples

Example 1: Update Cluster

$result = $client->updateCluster([
    'deletionProtectionEnabled' => ,
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);