[ aws . rds ]

stop-activity-stream

Description

Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action.

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

  stop-activity-stream
--resource-arn <value>
[--apply-immediately | --no-apply-immediately]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--resource-arn (string)

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

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

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

KmsKeyId -> (string)

The AWS KMS key identifier used for encrypting messages in the database activity stream.

KinesisStreamName -> (string)

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

Status -> (string)

The status of the database activity stream.