Skip to content

Modifies the KMS key for an existing database

Description

Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent update_database requests, first writer wins.

See code sample for details.

Usage

timestreamwrite_update_database(DatabaseName, KmsKeyId)

Arguments

  • DatabaseName

    [required] The name of the database.

  • KmsKeyId

    [required] 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

Value

A list with the following syntax:

list(
  Database = list(
    Arn = "string",
    DatabaseName = "string",
    TableCount = 123,
    KmsKeyId = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_database(
  DatabaseName = "string",
  KmsKeyId = "string"
)