StopActivityStream - Amazon Relational Database Service

StopActivityStream

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

For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ResourceArn

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.

Type: String

Required: Yes

ApplyImmediately

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

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.

KinesisStreamName

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

Type: String

KmsKeyId

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

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Type: String

Status

The status of the database activity stream.

Type: String

Valid Values: stopped | starting | started | stopping

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

ResourceNotFoundFault

The specified resource ID was not found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: