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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass StartActivityStreamRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

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)


22875
22876
22877
22878
22879
22880
22881
22882
22883
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 22875

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_includedBoolean

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

Returns:

  • (Boolean)


22875
22876
22877
22878
22879
22880
22881
22882
22883
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 22875

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

#kms_key_idString

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)


22875
22876
22877
22878
22879
22880
22881
22882
22883
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 22875

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

#modeString

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)


22875
22876
22877
22878
22879
22880
22881
22882
22883
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 22875

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

#resource_arnString

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

Returns:

  • (String)


22875
22876
22877
22878
22879
22880
22881
22882
22883
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 22875

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