aws rds start-activity-stream

Starts a database activity stream to monitor activity on the database. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To start a database activity stream

The following start-activity-stream example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.

aws rds start-activity-stream --mode async --kms-key-id arn:aws:kms:us-west-2:1234567890123:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 --resource-arn arn:aws:rds:us-west-2:1234567890123:cluster:my-pg-cluster --apply-immediately

Identify

--modeSpecifies the mode of the database activity stream.

--kms-key-idThe Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.

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

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

Its output

{
    "KmsKeyId": "arn:aws:kms:us-west-2:1234567890123:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
    "Status": "starting",
    "Mode": "async",
    "ApplyImmediately": true
}

For more information, see Starting a database activity stream in the Amazon Aurora User Guide.

Options

5 in the AWS CLI reference

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

--engine-native-audit-fields-includedSpecifies whether the database activity stream includes engine-native audit fields.

--kms-key-idThe Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.

--modeSpecifies the mode of the database activity stream.

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