AWS::RedshiftServerless::Namespace Namespace

A collection of database objects and users.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AdminPasswordSecretArn" : String,
  "AdminPasswordSecretKmsKeyId" : String,
  "AdminUsername" : String,
  "CreationDate" : String,
  "DbName" : String,
  "DefaultIamRoleArn" : String,
  "IamRoles" : [ String, ... ],
  "KmsKeyId" : String,
  "LogExports" : [ String, ... ],
  "NamespaceArn" : String,
  "NamespaceId" : String,
  "NamespaceName" : String,
  "Status" : String
}

YAML

  AdminPasswordSecretArn: String
  AdminPasswordSecretKmsKeyId: String
  AdminUsername: String
  CreationDate: String
  DbName: String
  DefaultIamRoleArn: String
  IamRoles: 
    - String
  KmsKeyId: String
  LogExports: 
    - String
  NamespaceArn: String
  NamespaceId: String
  NamespaceName: String
  Status: String

Properties

AdminPasswordSecretArn

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

Required: No

Type: String

Update requires: No interruption

AdminPasswordSecretKmsKeyId

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

Required: No

Type: String

Update requires: No interruption

AdminUsername

The username of the administrator for the first database created in the namespace.

Required: No

Type: String

Update requires: No interruption

CreationDate

The date of when the namespace was created.

Required: No

Type: String

Update requires: No interruption

DbName

The name of the first database created in the namespace.

Required: No

Type: String

Pattern: [a-zA-Z][a-zA-Z_0-9+.@-]*

Update requires: No interruption

DefaultIamRoleArn

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

Required: No

Type: String

Update requires: No interruption

IamRoles

A list of IAM roles to associate with the namespace.

Required: No

Type: Array of String

Minimum: 0

Maximum: 512

Update requires: No interruption

KmsKeyId

The ID of the AWS Key Management Service key used to encrypt your data.

Required: No

Type: String

Update requires: No interruption

LogExports

The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

Required: No

Type: Array of String

Minimum: 0

Maximum: 16

Update requires: No interruption

NamespaceArn

The Amazon Resource Name (ARN) associated with a namespace.

Required: No

Type: String

Update requires: No interruption

NamespaceId

The unique identifier of a namespace.

Required: No

Type: String

Update requires: No interruption

NamespaceName

The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Required: No

Type: String

Pattern: ^[a-z0-9-]+$

Minimum: 3

Maximum: 64

Update requires: No interruption

Status

The status of the namespace.

Required: No

Type: String

Allowed values: AVAILABLE | MODIFYING | DELETING

Update requires: No interruption