AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dsql ]

create-stream

Description

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

See also: AWS API Documentation

Synopsis

  create-stream
--cluster-identifier <value>
--target-definition <value>
--ordering <value>
--format <value>
[--tags <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--cluster-identifier (string)

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

--target-definition (tagged union structure)

The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: kinesis.

kinesis -> (structure)

Kinesis stream target configuration.

streamArn -> (string)

The ARN of the Kinesis stream.

roleArn -> (string)

The ARN of the IAM role that grants permission to write to the Kinesis stream. This can be a standard role (arn:aws:iam::account-id:role/role-name ) or a role with a path prefix (arn:aws:iam::account-id:role/service-role/role-name ), such as roles auto-created by the console.

Shorthand Syntax:

kinesis={streamArn=string,roleArn=string}

JSON Syntax:

{
  "kinesis": {
    "streamArn": "string",
    "roleArn": "string"
  }
}

--ordering (string)

The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

Possible values:

  • UNORDERED

--format (string)

The format of the stream records.

Possible values:

  • JSON

--tags (map)

A map of key and value pairs to use to tag your stream.

key -> (string)

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

value -> (string)

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

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you don’t specify a client token, the Amazon Web Services SDK automatically generates one.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

clusterIdentifier -> (string)

The ID of the cluster for the created stream.

streamIdentifier -> (string)

The ID of the created stream.

arn -> (string)

The ARN of the created stream.

status -> (string)

The status of the created stream.

creationTime -> (timestamp)

The time when created the stream.

ordering -> (string)

The ordering mode of the created stream.

format -> (string)

The format of the created stream records.