aws-cdk-lib.aws_redshiftserverless.CfnNamespaceProps

interface CfnNamespaceProps

LanguageType name
.NETAmazon.CDK.AWS.RedshiftServerless.CfnNamespaceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsredshiftserverless#CfnNamespaceProps
Javasoftware.amazon.awscdk.services.redshiftserverless.CfnNamespaceProps
Pythonaws_cdk.aws_redshiftserverless.CfnNamespaceProps
TypeScript aws-cdk-lib » aws_redshiftserverless » CfnNamespaceProps

Properties for defining a CfnNamespace.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshiftserverless as redshiftserverless } from 'aws-cdk-lib';
const cfnNamespaceProps: redshiftserverless.CfnNamespaceProps = {
  namespaceName: 'namespaceName',

  // the properties below are optional
  adminUsername: 'adminUsername',
  adminUserPassword: 'adminUserPassword',
  dbName: 'dbName',
  defaultIamRoleArn: 'defaultIamRoleArn',
  finalSnapshotName: 'finalSnapshotName',
  finalSnapshotRetentionPeriod: 123,
  iamRoles: ['iamRoles'],
  kmsKeyId: 'kmsKeyId',
  logExports: ['logExports'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namespaceNamestringThe name of the namespace.
adminUserPassword?stringThe password of the administrator for the primary database created in the namespace.
adminUsername?stringThe username of the administrator for the primary database created in the namespace.
dbName?stringThe name of the primary database created in the namespace.
defaultIamRoleArn?stringThe Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
finalSnapshotName?stringThe name of the snapshot to be created before the namespace is deleted.
finalSnapshotRetentionPeriod?numberHow long to retain the final snapshot.
iamRoles?string[]A list of IAM roles to associate with the namespace.
kmsKeyId?stringThe ID of the AWS Key Management Service key used to encrypt your data.
logExports?string[]The types of logs the namespace can export.
tags?CfnTag[]The map of the key-value pairs used to tag the namespace.

namespaceName

Type: 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 in the Amazon Redshift Database Developer Guide.


adminUserPassword?

Type: string (optional)

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


adminUsername?

Type: string (optional)

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


dbName?

Type: string (optional)

The name of the primary database created in the namespace.


defaultIamRoleArn?

Type: string (optional)

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


finalSnapshotName?

Type: string (optional)

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


finalSnapshotRetentionPeriod?

Type: number (optional)

How long to retain the final snapshot.


iamRoles?

Type: string[] (optional)

A list of IAM roles to associate with the namespace.


kmsKeyId?

Type: string (optional)

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


logExports?

Type: string[] (optional)

The types of logs the namespace can export.

Available export types are userlog , connectionlog , and useractivitylog .


tags?

Type: CfnTag[] (optional)

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