Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rds ]

start-activity-stream

Description

Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-activity-stream
--resource-arn <value>
--mode <value>
--kms-key-id <value>
[--apply-immediately | --no-apply-immediately]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resource-arn (string)

The Amazon Resource Name (ARN) of the DB cluster, for example arn:aws:rds:us-east-1:12345667890:cluster:das-cluster .

--mode (string)

Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Possible values:

  • sync
  • async

--kms-key-id (string)

The AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier can be either a key ID, a key ARN, or a key alias.

--apply-immediately | --no-apply-immediately (boolean)

Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

--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.

See 'aws help' for descriptions of global parameters.

Output

KmsKeyId -> (string)

The AWS KMS key identifier for encryption of messages in the database activity stream.

KinesisStreamName -> (string)

The name of the Amazon Kinesis data stream to be used for the database activity stream.

Status -> (string)

The status of the database activity stream.

Mode -> (string)

The mode of the database activity stream.

ApplyImmediately -> (boolean)

Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.