databases

Creates, updates, deletes or gets a database resource or lists databases in a region

Overview

Name	databases
Type	Resource
Description	The AWS::Timestream::Database resource creates a Timestream database.
Id	awscc.timestream.databases

Fields

get (all properties)

Name	Datatype	Description
arn	string
database_name	string	The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
kms_key_id	string	The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
database_name	string	The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name.
region	string	AWS region.

For more information, see AWS::Timestream::Database.

Methods

Name	Resource	Accessible by	Required Params
create_resource	databases	INSERT	region
delete_resource	databases	DELETE	Identifier, region
update_resource	databases	UPDATE	Identifier, PatchDocument, region
list_resources	databases_list_only	SELECT	region
get_resource	databases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual database.

SELECT
  region,
  arn,
  database_name,
  kms_key_id,
  tags
FROM awscc.timestream.databases
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ database_name }}';

list (identifiers only)

Lists all databases in a region.

SELECT
  region,
  database_name
FROM awscc.timestream.databases_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new database resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.timestream.databases (
  DatabaseName,
  KmsKeyId,
  Tags,
  region
)
SELECT
  '{{ database_name }}',
  '{{ kms_key_id }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.timestream.databases (
  DatabaseName,
  KmsKeyId,
  Tags,
  region
)
SELECT
  '{{ database_name }}',
  '{{ kms_key_id }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: database
    props:
      - name: database_name
        value: '{{ database_name }}'
      - name: kms_key_id
        value: '{{ kms_key_id }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a database resource, using stack-deploy.

/*+ update */
UPDATE awscc.timestream.databases
SET PatchDocument = string('{{ {
    "KmsKeyId": kms_key_id,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ database_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.timestream.databases
WHERE
  Identifier = '{{ database_name }}' AND
  region = 'us-east-1';

Permissions

To operate on the databases resource, the following permissions are required:

Create

timestream:CreateDatabase,
timestream:DescribeEndpoints,
timestream:TagResource,
kms:CreateGrant,
kms:DescribeKey,
kms:Decrypt

Read

timestream:DescribeDatabase,
timestream:DescribeEndpoints,
timestream:ListTagsForResource

Update

timestream:UpdateDatabase,
timestream:DescribeDatabase,
timestream:DescribeEndpoints,
timestream:TagResource,
timestream:UntagResource

Delete

timestream:DeleteDatabase,
timestream:DescribeEndpoints

List

timestream:ListDatabases,
timestream:DescribeEndpoints