Start Activity Stream

rds_start_activity_stream

R Documentation

Starts a database activity stream to monitor activity on the database

Description

Starts a database activity stream to monitor activity on the database. 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.

Usage

rds_start_activity_stream(ResourceArn, Mode, KmsKeyId, ApplyImmediately,
  EngineNativeAuditFieldsIncluded)

Arguments

ResourceArn

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

Mode

[required] 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.

KmsKeyId

[required] The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

ApplyImmediately

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

EngineNativeAuditFieldsIncluded

Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

Value

A list with the following syntax:

list(
  KmsKeyId = "string",
  KinesisStreamName = "string",
  Status = "stopped"|"starting"|"started"|"stopping",
  Mode = "sync"|"async",
  ApplyImmediately = TRUE|FALSE,
  EngineNativeAuditFieldsIncluded = TRUE|FALSE
)

Request syntax

svc$start_activity_stream(
  ResourceArn = "string",
  Mode = "sync"|"async",
  KmsKeyId = "string",
  ApplyImmediately = TRUE|FALSE,
  EngineNativeAuditFieldsIncluded = TRUE|FALSE
)