AWS::RedshiftServerless::Namespace

A collection of database objects and users.

Syntax

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

JSON

{
  "Type" : "AWS::RedshiftServerless::Namespace",
  "Properties" : {
      "AdminPasswordSecretKmsKeyId" : String,
      "AdminUsername" : String,
      "AdminUserPassword" : String,
      "DbName" : String,
      "DefaultIamRoleArn" : String,
      "FinalSnapshotName" : String,
      "FinalSnapshotRetentionPeriod" : Integer,
      "IamRoles" : [ String, ... ],
      "KmsKeyId" : String,
      "LogExports" : [ String, ... ],
      "ManageAdminPassword" : Boolean,
      "NamespaceName" : String,
      "NamespaceResourcePolicy" : Json,
      "RedshiftIdcApplicationArn" : String,
      "SnapshotCopyConfigurations" : [ SnapshotCopyConfiguration, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::RedshiftServerless::Namespace
Properties:
  AdminPasswordSecretKmsKeyId: String
  AdminUsername: String
  AdminUserPassword: String
  DbName: String
  DefaultIamRoleArn: String
  FinalSnapshotName: String
  FinalSnapshotRetentionPeriod: Integer
  IamRoles: 
    - String
  KmsKeyId: String
  LogExports: 
    - String
  ManageAdminPassword: Boolean
  NamespaceName: String
  NamespaceResourcePolicy: Json
  RedshiftIdcApplicationArn: String
  SnapshotCopyConfigurations: 
    - SnapshotCopyConfiguration
  Tags: 
    - Tag

Properties

AdminPasswordSecretKmsKeyId

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if ManageAdminPassword is true.

Required: No

Type: String

Update requires: No interruption

AdminUsername

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

Required: No

Type: String

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

Update requires: No interruption

AdminUserPassword

The password of the administrator for the primary database created in the namespace.

Required: No

Type: String

Pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[^\x00-\x20\x22\x27\x2f\x40\x5c\x7f-\uffff]+

Minimum: 8

Maximum: 64

Update requires: No interruption

DbName

The name of the primary database created in the namespace.

Required: No

Type: String

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

Maximum: 127

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

FinalSnapshotName

The name of the snapshot to be created before the namespace is deleted.

Required: No

Type: String

Pattern: [a-z][a-z0-9]*(-[a-z0-9]+)*

Maximum: 255

Update requires: No interruption

FinalSnapshotRetentionPeriod

How long to retain the final snapshot.

Required: No

Type: Integer

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 userlog, connectionlog, and useractivitylog.

Required: No

Type: Array of String

Minimum: 0

Maximum: 16

Update requires: No interruption

ManageAdminPassword

If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't use AdminUserPassword if ManageAdminPassword is true. If ManageAdminPassword is false or not set, Amazon Redshift uses AdminUserPassword for the admin user account's password.

Required: No

Type: Boolean

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: Yes

Type: String

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

Minimum: 3

Maximum: 64

Update requires: Replacement

NamespaceResourcePolicy

The resource policy that will be attached to the namespace.

Required: No

Type: Json

Update requires: No interruption

RedshiftIdcApplicationArn

The ARN for the Redshift application that integrates with IAM Identity Center.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

SnapshotCopyConfigurations

Property description not available.

Required: No

Type: Array of SnapshotCopyConfiguration

Minimum: 0

Maximum: 1

Update requires: No interruption

Tags

The map of the key-value pairs used to tag the namespace.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: Replacement

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the NamespaceName, such as sample-namespace. For more information about using the Ref function, see Ref.

Fn::GetAtt

GetAtt returns a value for a specified attribute of this type. For more information, see Fn::GetAtt. The following are the available attributes and sample return values.

Namespace.AdminUsername

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

Namespace.CreationDate

The date of when the namespace was created.

Namespace.DbName

The name of the first database created in the namespace.

Namespace.DefaultIamRoleArn

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

Namespace.IamRoles

A list of IAM roles to associate with the namespace.

Namespace.KmsKeyId

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

Namespace.LogExports

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

Namespace.NamespaceArn

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

Namespace.NamespaceId

The unique identifier of a namespace.

Namespace.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.

Namespace.Status

The status of the namespace.