Class: Aws::TimestreamWrite::Types::UpdateDatabaseRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-timestreamwrite/types.rb

Overview

Note:

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

{
  database_name: "ResourceName", # required
  kms_key_id: "StringValue2048", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#database_nameString

The name of the database.

Returns:

  • (String)


1220
1221
1222
1223
1224
1225
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 1220

class UpdateDatabaseRequest < Struct.new(
  :database_name,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The identifier of the new KMS key (‘KmsKeyId`) to be used to encrypt the data stored in the database. If the `KmsKeyId` currently registered with the database is the same as the `KmsKeyId` in the request, there will not be any update.

You can specify the ‘KmsKeyId` using any of the following:

  • Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`

  • Key ARN: ‘arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

  • Alias name: ‘alias/ExampleAlias`

  • Alias ARN: ‘arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias`

Returns:

  • (String)


1220
1221
1222
1223
1224
1225
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 1220

class UpdateDatabaseRequest < Struct.new(
  :database_name,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end