[ aws . timestream-write ]

update-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 UpdateDatabase requests, first writer wins.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-database
--database-name <value>
--kms-key-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--database-name (string)

The name of the database.

--kms-key-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Database -> (structure)

A top level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same KMS key.

Arn -> (string)

The Amazon Resource Name that uniquely identifies this database.

DatabaseName -> (string)

The name of the Timestream database.

TableCount -> (long)

The total number of tables found within a Timestream database.

KmsKeyId -> (string)

The identifier of the KMS key used to encrypt the data stored in the database.

CreationTime -> (timestamp)

The time when the database was created, calculated from the Unix epoch time.

LastUpdatedTime -> (timestamp)

The last time that this database was updated.