Module Awso_dsql.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule String_ : sig ... end
Sourcemodule ValidationExceptionField : sig ... end

Stores information about a field passed inside a request that resulted in an validation error.

Sourcemodule ClusterArn : sig ... end

The Amazon Resource Name of the cluster.

Sourcemodule ClusterId : sig ... end

The ID of the cluster.

Sourcemodule StreamArn : sig ... end

The Amazon Resource Name (ARN) of the stream.

Sourcemodule StreamCreationTime : sig ... end

The timestamp when the stream was created.

Sourcemodule StreamId : sig ... end

The ID of the stream.

Sourcemodule StreamStatus : sig ... end
Sourcemodule KinesisStreamArn : sig ... end

The Amazon Resource Name (ARN) of an Amazon Kinesis Data Stream.

Sourcemodule RoleArn : sig ... end

The Amazon Resource Name (ARN) of an IAM role.

Sourcemodule Integer : sig ... end
Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule ClusterArnList : sig ... end
Sourcemodule Region : sig ... end

Region name.

Sourcemodule TagKey : sig ... end

Unique tag key, maximum 128 Unicode characters in UTF-8.

Sourcemodule TagValue : sig ... end

Tag value, maximum 256 Unicode characters in UTF-8.

Sourcemodule StreamSummary : sig ... end

Summary information about a stream.

Sourcemodule ClusterSummary : sig ... end

A summary of the properties of a cluster.

Sourcemodule StreamFailureErrorCode : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule KinesisTargetDefinition : sig ... end

Kinesis stream target configuration.

Sourcemodule EncryptionStatus : sig ... end
Sourcemodule EncryptionType : sig ... end
Sourcemodule KmsKeyArn : sig ... end
Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule ClusterCreationTime : sig ... end

The timestamp when the cluster was created.

Sourcemodule ClusterStatus : sig ... end
Sourcemodule ConflictException : sig ... end

The submitted action has conflicts.

Sourcemodule InternalServerException : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

The resource could not be found.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

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

Sourcemodule ClientToken : sig ... end

Idempotency token so a request is only processed once.

Sourcemodule DeletionProtectionEnabled : sig ... end

Indicates whether deletion protection is enabled for a cluster.

Sourcemodule KmsEncryptionKey : sig ... end
Sourcemodule MultiRegionProperties : sig ... end

Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.

Sourcemodule Arn : sig ... end

Amazon Resource Name.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule PolicyVersion : sig ... end
Sourcemodule PolicyDocument : sig ... end

A resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).

Sourcemodule NextToken : sig ... end

Token used to retrieve next page.

Sourcemodule StreamList : sig ... end
Sourcemodule MaxResults : sig ... end

Max results that will be returned per page.

Sourcemodule ClusterList : sig ... end
Sourcemodule ClusterVpcEndpoint : sig ... end
Sourcemodule ServiceName : sig ... end

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.

Sourcemodule StatusReason : sig ... end

Stream status reason with error and timestamp.

Sourcemodule StreamFormat : sig ... end
Sourcemodule StreamOrdering : sig ... end
Sourcemodule TargetDefinition : sig ... end

Target definition for stream destination.

Sourcemodule EncryptionDetails : sig ... end

Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.

Sourcemodule Endpoint : sig ... end

The service limit was exceeded.

Sourcemodule UpdateClusterOutput : sig ... end

The details of the cluster after it has been updated.

Sourcemodule UpdateClusterInput : sig ... end

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.

Sourcemodule UntagResourceInput : sig ... end

Removes a tag from a resource.

Sourcemodule TagResourceInput : sig ... end

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

Sourcemodule PutClusterPolicyOutput : sig ... end

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.

Sourcemodule PutClusterPolicyInput : sig ... end

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.

Sourcemodule ListTagsForResourceOutput : sig ... end

Lists all of the tags for a resource.

Sourcemodule ListTagsForResourceInput : sig ... end

Lists all of the tags for a resource.

Sourcemodule ListStreamsOutput : sig ... end

Retrieves information about a list of streams for a cluster.

Sourcemodule ListStreamsInput : sig ... end

Retrieves information about a list of streams for a cluster.

Sourcemodule ListClustersOutput : sig ... end

Retrieves information about a list of clusters.

Sourcemodule ListClustersInput : sig ... end

Retrieves information about a list of clusters.

Retrieves the VPC endpoint service name.

Retrieves the VPC endpoint service name.

Sourcemodule GetStreamOutput : sig ... end

The output of a retrieved stream.

Sourcemodule GetStreamInput : sig ... end

Retrieves information about a stream.

Sourcemodule GetClusterPolicyOutput : sig ... end

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

Sourcemodule GetClusterPolicyInput : sig ... end

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

Sourcemodule GetClusterOutput : sig ... end

The output of a cluster.

Sourcemodule GetClusterInput : sig ... end

Retrieves information about a cluster.

Sourcemodule DeleteStreamOutput : sig ... end

The output from a deleted stream.

Sourcemodule DeleteStreamInput : sig ... end

Deletes a stream from a cluster.

Sourcemodule DeleteClusterPolicyOutput : sig ... end

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

Sourcemodule DeleteClusterPolicyInput : sig ... end

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

Sourcemodule DeleteClusterOutput : sig ... end

The output from a deleted cluster.

Sourcemodule DeleteClusterInput : sig ... end

Deletes a cluster in Amazon Aurora DSQL.

Sourcemodule CreateStreamOutput : sig ... end

The output of a created stream.

Sourcemodule CreateStreamInput : sig ... end

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

Sourcemodule CreateClusterOutput : sig ... end

The output of a created cluster.

Sourcemodule CreateClusterInput : sig ... end

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.