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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::StartActivityStreamRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #engine_native_audit_fields_included ⇒ Boolean

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

• #kms_key_id ⇒ String

  The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.

• #mode ⇒ 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`.

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)

# File 'lib/aws-sdk-rds/types.rb', line 27149

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately,
  :engine_native_audit_fields_included)
  SENSITIVE = []
  include Aws::Structure
end

#engine_native_audit_fields_included ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 27149

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately,
  :engine_native_audit_fields_included)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 27149

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately,
  :engine_native_audit_fields_included)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 27149

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately,
  :engine_native_audit_fields_included)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rds/types.rb', line 27149

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately,
  :engine_native_audit_fields_included)
  SENSITIVE = []
  include Aws::Structure
end