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,
}

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)


19386
19387
19388
19389
19390
19391
19392
19393
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19386

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

#kms_key_idString

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)


19386
19387
19388
19389
19390
19391
19392
19393
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19386

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately)
  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)


19386
19387
19388
19389
19390
19391
19392
19393
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19386

class StartActivityStreamRequest < Struct.new(
  :resource_arn,
  :mode,
  :kms_key_id,
  :apply_immediately)
  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)


19386
19387
19388
19389
19390
19391
19392
19393
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19386

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