interface CfnNamespaceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.RedshiftServerless.CfnNamespaceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsredshiftserverless#CfnNamespaceProps |
Java | software.amazon.awscdk.services.redshiftserverless.CfnNamespaceProps |
Python | aws_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';
declare const namespaceResourcePolicy: any;
const cfnNamespaceProps: redshiftserverless.CfnNamespaceProps = {
namespaceName: 'namespaceName',
// the properties below are optional
adminPasswordSecretKmsKeyId: 'adminPasswordSecretKmsKeyId',
adminUsername: 'adminUsername',
adminUserPassword: 'adminUserPassword',
dbName: 'dbName',
defaultIamRoleArn: 'defaultIamRoleArn',
finalSnapshotName: 'finalSnapshotName',
finalSnapshotRetentionPeriod: 123,
iamRoles: ['iamRoles'],
kmsKeyId: 'kmsKeyId',
logExports: ['logExports'],
manageAdminPassword: false,
namespaceResourcePolicy: namespaceResourcePolicy,
redshiftIdcApplicationArn: 'redshiftIdcApplicationArn',
snapshotCopyConfigurations: [{
destinationRegion: 'destinationRegion',
// the properties below are optional
destinationKmsKeyId: 'destinationKmsKeyId',
snapshotRetentionPeriod: 123,
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
namespace | string | The name of the namespace. |
admin | string | The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. |
admin | string | The password of the administrator for the primary database created in the namespace. |
admin | string | The username of the administrator for the primary database created in the namespace. |
db | string | The name of the primary database created in the namespace. |
default | string | The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. |
final | string | The name of the snapshot to be created before the namespace is deleted. |
final | number | How long to retain the final snapshot. |
iam | string[] | A list of IAM roles to associate with the namespace. |
kms | string | The ID of the AWS Key Management Service key used to encrypt your data. |
log | string[] | The types of logs the namespace can export. |
manage | boolean | IResolvable | If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. |
namespace | any | The resource policy that will be attached to the namespace. |
redshift | string | The ARN for the Redshift application that integrates with IAM Identity Center. |
snapshot | IResolvable | IResolvable | Snapshot [] | The snapshot copy configurations for the namespace. |
tags? | Cfn [] | 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.
adminPasswordSecretKmsKeyId?
Type:
string
(optional)
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
.
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
.
manageAdminPassword?
Type:
boolean |
IResolvable
(optional)
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.
namespaceResourcePolicy?
Type:
any
(optional)
The resource policy that will be attached to the namespace.
redshiftIdcApplicationArn?
Type:
string
(optional)
The ARN for the Redshift application that integrates with IAM Identity Center.
snapshotCopyConfigurations?
Type:
IResolvable
|
IResolvable
|
Snapshot
[]
(optional)
The snapshot copy configurations for the namespace.
tags?
Type:
Cfn
[]
(optional)
The map of the key-value pairs used to tag the namespace.