NamespaceProperty Struct
A collection of database objects and users.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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 namespaceProperty: redshiftserverless.CfnNamespace.NamespaceProperty = {
adminPasswordSecretArn: 'adminPasswordSecretArn',
adminPasswordSecretKmsKeyId: 'adminPasswordSecretKmsKeyId',
adminUsername: 'adminUsername',
creationDate: 'creationDate',
dbName: 'dbName',
defaultIamRoleArn: 'defaultIamRoleArn',
iamRoles: ['iamRoles'],
kmsKeyId: 'kmsKeyId',
logExports: ['logExports'],
namespaceArn: 'namespaceArn',
namespaceId: 'namespaceId',
namespaceName: 'namespaceName',
status: 'status',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_redshiftserverless as redshiftserverless
namespace_property = redshiftserverless.CfnNamespace.NamespaceProperty(
admin_password_secret_arn="adminPasswordSecretArn",
admin_password_secret_kms_key_id="adminPasswordSecretKmsKeyId",
admin_username="adminUsername",
creation_date="creationDate",
db_name="dbName",
default_iam_role_arn="defaultIamRoleArn",
iam_roles=["iamRoles"],
kms_key_id="kmsKeyId",
log_exports=["logExports"],
namespace_arn="namespaceArn",
namespace_id="namespaceId",
namespace_name="namespaceName",
status="status"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.redshiftserverless.*;
NamespaceProperty namespaceProperty = NamespaceProperty.builder()
.adminPasswordSecretArn("adminPasswordSecretArn")
.adminPasswordSecretKmsKeyId("adminPasswordSecretKmsKeyId")
.adminUsername("adminUsername")
.creationDate("creationDate")
.dbName("dbName")
.defaultIamRoleArn("defaultIamRoleArn")
.iamRoles(List.of("iamRoles"))
.kmsKeyId("kmsKeyId")
.logExports(List.of("logExports"))
.namespaceArn("namespaceArn")
.namespaceId("namespaceId")
.namespaceName("namespaceName")
.status("status")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RedshiftServerless;
var namespaceProperty = new NamespaceProperty {
AdminPasswordSecretArn = "adminPasswordSecretArn",
AdminPasswordSecretKmsKeyId = "adminPasswordSecretKmsKeyId",
AdminUsername = "adminUsername",
CreationDate = "creationDate",
DbName = "dbName",
DefaultIamRoleArn = "defaultIamRoleArn",
IamRoles = new [] { "iamRoles" },
KmsKeyId = "kmsKeyId",
LogExports = new [] { "logExports" },
NamespaceArn = "namespaceArn",
NamespaceId = "namespaceId",
NamespaceName = "namespaceName",
Status = "status"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
namespaceProperty := &NamespaceProperty{
AdminPasswordSecretArn: jsii.String("adminPasswordSecretArn"),
AdminPasswordSecretKmsKeyId: jsii.String("adminPasswordSecretKmsKeyId"),
AdminUsername: jsii.String("adminUsername"),
CreationDate: jsii.String("creationDate"),
DbName: jsii.String("dbName"),
DefaultIamRoleArn: jsii.String("defaultIamRoleArn"),
IamRoles: []*string{
jsii.String("iamRoles"),
},
KmsKeyId: jsii.String("kmsKeyId"),
LogExports: []*string{
jsii.String("logExports"),
},
NamespaceArn: jsii.String("namespaceArn"),
NamespaceId: jsii.String("namespaceId"),
NamespaceName: jsii.String("namespaceName"),
Status: jsii.String("status"),
}
Properties
adminPasswordSecretArnoptionalstringadmin_password_secret_arnoptionalstradminPasswordSecretArnoptionalStringAdminPasswordSecretArnoptionalstringAdminPasswordSecretArnoptional*string #The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
adminPasswordSecretKmsKeyIdoptionalstringadmin_password_secret_kms_key_idoptionalstradminPasswordSecretKmsKeyIdoptionalStringAdminPasswordSecretKmsKeyIdoptionalstringAdminPasswordSecretKmsKeyIdoptional*string #The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
adminUsernameoptionalstringadmin_usernameoptionalstradminUsernameoptionalStringAdminUsernameoptionalstringAdminUsernameoptional*string #The username of the administrator for the first database created in the namespace.
creationDateoptionalstringcreation_dateoptionalstrcreationDateoptionalStringCreationDateoptionalstringCreationDateoptional*string #The date of when the namespace was created.
dbNameoptionalstringdb_nameoptionalstrdbNameoptionalStringDbNameoptionalstringDbNameoptional*string #The name of the first database created in the namespace.
defaultIamRoleArnoptionalstringdefault_iam_role_arnoptionalstrdefaultIamRoleArnoptionalStringDefaultIamRoleArnoptionalstringDefaultIamRoleArnoptional*string #The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRolesoptionalstring[]iam_rolesoptionaltyping.List[str]iamRolesoptionalList<String>IamRolesoptionalstring[]IamRolesoptional*[]*string #A list of IAM roles to associate with the namespace.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string #The ID of the AWS Key Management Service key used to encrypt your data.
logExportsoptionalstring[]log_exportsoptionaltyping.List[str]logExportsoptionalList<String>LogExportsoptionalstring[]LogExportsoptional*[]*string #The types of logs the namespace can export.
Available export types are User log, Connection log, and User activity log.
namespaceArnoptionalstringnamespace_arnoptionalstrnamespaceArnoptionalStringNamespaceArnoptionalstringNamespaceArnoptional*string #The Amazon Resource Name (ARN) associated with a namespace.
namespaceIdoptionalstringnamespace_idoptionalstrnamespaceIdoptionalStringNamespaceIdoptionalstringNamespaceIdoptional*string #The unique identifier of a namespace.
namespaceNameoptionalstringnamespace_nameoptionalstrnamespaceNameoptionalStringNamespaceNameoptionalstringNamespaceNameoptional*string #The name of the namespace.
notes
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.
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string #The status of the namespace.