Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14168671.3 KB

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

post/stream/{clusterIdentifier}

Path parameters

clusterIdentifierstring required

The ID of the cluster.

The ID of the cluster for which to create the stream.

Request body

ordering'UNORDERED' required
<p>Stream ordering mode.</p> <dl> <dt>UNORDERED</dt> <dd> <p>Changes are streamed without ordering guarantees.</p> </dd> </dl>
format'JSON' required
<p>Stream record format.</p> <dl> <dt>JSON</dt> <dd> <p>Stream records are formatted as JSON.</p> </dd> </dl>
tagsobject

Map of tags.

clientTokenstring

Idempotency token so a request is only processed once.

Response

Success

clusterIdentifierstring required

The ID of the cluster for the created stream.

streamIdentifierstring required

The ID of the created stream.

arnstring required

The ARN of the created stream.

status'CREATING' | 'ACTIVE' | 'DELETING' | 'DELETED' | 'FAILED' | 'IMPAIRED' required

The status of the created stream.

creationTimestring date-time required

The time when created the stream.

ordering'UNORDERED' required

The ordering mode of the created stream.

format'JSON' required

The format of the created stream records.