You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::StartActivityStreamRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartActivityStreamRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  resource_arn: "String", # required
  mode: "sync", # required, accepts sync, async
  kms_key_id: "String", # required
  apply_immediately: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (Boolean) —

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

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

Returns:

  • (String) —

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

#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

Returns:

  • (String) —

    Specifies the mode of the database activity stream.

#resource_arn ⇒ String

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

Returns:

  • (String) —

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