AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RedshiftServerless::Namespace

CfnNamespace

A collection of database objects and users.

Import

import { CfnNamespace } from 'aws-cdk-lib/aws-redshiftserverless';

Or use the module namespace:

import * as redshiftserverless from 'aws-cdk-lib/aws-redshiftserverless';
// redshiftserverless.CfnNamespace

Properties

Configuration passed to the constructor as CfnNamespaceProps.

namespaceNameRequired
string

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](https://docs.aws.amazon.com//redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide.

adminPasswordSecretKmsKeyIdOptional
string

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

adminUsernameOptional
string

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

adminUserPasswordOptional
string

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

dbNameOptional
string

The name of the primary database created in the namespace.

defaultIamRoleArnOptional
string | IRoleRef

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

finalSnapshotNameOptional
string

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

finalSnapshotRetentionPeriodOptional
number

How long to retain the final snapshot.

iamRolesOptional
string | IRoleRef[]

A list of IAM roles to associate with the namespace.

kmsKeyIdOptional
string | IKeyRef

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

logExportsOptional
string[]

The types of logs the namespace can export. Available export types are `userlog` , `connectionlog` , and `useractivitylog` .

manageAdminPasswordOptional
boolean | IResolvable

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.

namespaceResourcePolicyOptional
any

The resource policy that will be attached to the namespace.

redshiftIdcApplicationArnOptional
string

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

snapshotCopyConfigurationsOptional
IResolvable | IResolvable | SnapshotCopyConfigurationProperty[]

The snapshot copy configurations for the namespace.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::RedshiftServerless::NamespaceView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-redshiftserverless
CFN TypeAWS::RedshiftServerless::Namespace
Properties16

Related Constructs

Explore This Service

External Links