Awso_dsql_asyncSourceval create_cluster :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.CreateClusterInput.t ->
(Awso_dsql.Values.CreateClusterOutput.t,
Awso_dsql.Values.CreateClusterOutput.error)
Result.t
Async.Deferred.tval create_stream :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.CreateStreamInput.t ->
(Awso_dsql.Values.CreateStreamOutput.t,
Awso_dsql.Values.CreateStreamOutput.error)
Result.t
Async.Deferred.tval delete_cluster :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.DeleteClusterInput.t ->
(Awso_dsql.Values.DeleteClusterOutput.t,
Awso_dsql.Values.DeleteClusterOutput.error)
Result.t
Async.Deferred.tval delete_cluster_policy :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.DeleteClusterPolicyInput.t ->
(Awso_dsql.Values.DeleteClusterPolicyOutput.t,
Awso_dsql.Values.DeleteClusterPolicyOutput.error)
Result.t
Async.Deferred.tval delete_stream :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.DeleteStreamInput.t ->
(Awso_dsql.Values.DeleteStreamOutput.t,
Awso_dsql.Values.DeleteStreamOutput.error)
Result.t
Async.Deferred.tval get_cluster :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.GetClusterInput.t ->
(Awso_dsql.Values.GetClusterOutput.t,
Awso_dsql.Values.GetClusterOutput.error)
Result.t
Async.Deferred.tval get_cluster_policy :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.GetClusterPolicyInput.t ->
(Awso_dsql.Values.GetClusterPolicyOutput.t,
Awso_dsql.Values.GetClusterPolicyOutput.error)
Result.t
Async.Deferred.tval get_stream :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.GetStreamInput.t ->
(Awso_dsql.Values.GetStreamOutput.t, Awso_dsql.Values.GetStreamOutput.error)
Result.t
Async.Deferred.tval get_vpc_endpoint_service_name :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.GetVpcEndpointServiceNameInput.t ->
(Awso_dsql.Values.GetVpcEndpointServiceNameOutput.t,
Awso_dsql.Values.GetVpcEndpointServiceNameOutput.error)
Result.t
Async.Deferred.tval list_clusters :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.ListClustersInput.t ->
(Awso_dsql.Values.ListClustersOutput.t,
Awso_dsql.Values.ListClustersOutput.error)
Result.t
Async.Deferred.tval list_streams :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.ListStreamsInput.t ->
(Awso_dsql.Values.ListStreamsOutput.t,
Awso_dsql.Values.ListStreamsOutput.error)
Result.t
Async.Deferred.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.ListTagsForResourceInput.t ->
(Awso_dsql.Values.ListTagsForResourceOutput.t,
Awso_dsql.Values.ListTagsForResourceOutput.error)
Result.t
Async.Deferred.tval put_cluster_policy :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.PutClusterPolicyInput.t ->
(Awso_dsql.Values.PutClusterPolicyOutput.t,
Awso_dsql.Values.PutClusterPolicyOutput.error)
Result.t
Async.Deferred.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.TagResourceInput.t ->
(unit, unit) Result.t Async.Deferred.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.UntagResourceInput.t ->
(unit, unit) Result.t Async.Deferred.tval update_cluster :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_dsql.Values.UpdateClusterInput.t ->
(Awso_dsql.Values.UpdateClusterOutput.t,
Awso_dsql.Values.UpdateClusterOutput.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_dsql.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Stores information about a field passed inside a request that resulted in an validation error.
The Amazon Resource Name of the cluster.
The ID of the cluster.
The Amazon Resource Name (ARN) of the stream.
The timestamp when the stream was created.
The ID of the stream.
The Amazon Resource Name (ARN) of an Amazon Kinesis Data Stream.
The Amazon Resource Name (ARN) of an IAM role.
Region name.
Unique tag key, maximum 128 Unicode characters in UTF-8.
Tag value, maximum 256 Unicode characters in UTF-8.
Summary information about a stream.
A summary of the properties of a cluster.
Kinesis stream target configuration.
You do not have sufficient access to perform this action.
The timestamp when the cluster was created.
The submitted action has conflicts.
The request processing has failed because of an unknown error, exception or failure.
The resource could not be found.
The request was denied due to request throttling.
The input failed to satisfy the constraints specified by an Amazon Web Services service.
Idempotency token so a request is only processed once.
Indicates whether deletion protection is enabled for a cluster.
Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.
Amazon Resource Name.
A resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).
Token used to retrieve next page.
Max results that will be returned per page.
The name of the VPC endpoint service that provides access to your cluster. Use this endpoint to establish a private connection between your VPC and the cluster.
Stream status reason with error and timestamp.
Target definition for stream destination.
Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.
The service limit was exceeded.
The details of the cluster after it has been updated.
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.
Removes a tag from a resource.
Tags a resource with a map of key and value pairs.
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.
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.
Lists all of the tags for a resource.
Lists all of the tags for a resource.
Retrieves information about a list of streams for a cluster.
Retrieves information about a list of streams for a cluster.
Retrieves information about a list of clusters.
Retrieves information about a list of clusters.
Retrieves the VPC endpoint service name.
Retrieves the VPC endpoint service name.
The output of a retrieved stream.
Retrieves information about a stream.
Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.
Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.
The output of a cluster.
Retrieves information about a cluster.
The output from a deleted stream.
Deletes a stream from a cluster.
Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.
Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.
The output from a deleted cluster.
Deletes a cluster in Amazon Aurora DSQL.
The output of a created stream.
Creates a new change data capture (CDC) stream for a cluster. The stream captures database changes and delivers them to the specified target destination. Required permissions dsql:CreateStream Permission to create a new stream. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id iam:PassRole Permission to pass the IAM role specified in the target definition to the service. Resources: ARN of the IAM role specified in targetDefinition.kinesis.roleArn kms:Decrypt Required when the cluster uses a customer managed KMS key (CMK). Permission to decrypt data using the cluster's CMK. Resources: ARN of the KMS key used by the cluster
The output of a created cluster.
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.