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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


19851
19852
19853
19854
19855
19856
19857
19858
 
# File 'lib/aws-sdk-rds/types.rb', line 19851

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

#kms_key_id ⇒ String

The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Returns:

  • (String) 


19851
19852
19853
19854
19855
19856
19857
19858
 
# File 'lib/aws-sdk-rds/types.rb', line 19851

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


19851
19852
19853
19854
19855
19856
19857
19858
 
# File 'lib/aws-sdk-rds/types.rb', line 19851

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


19851
19852
19853
19854
19855
19856
19857
19858
 
# File 'lib/aws-sdk-rds/types.rb', line 19851

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