Package software.amazon.awscdk.services.redshiftserverless

Class CfnNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.redshiftserverless.CfnNamespace
All Implemented Interfaces:
IInspectable, ITaggable, INamespaceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:45.679Z") @Stability(Stable) public class CfnNamespace extends CfnResource implements IInspectable, INamespaceRef, ITaggable
A collection of database objects and users.

Example: 

 // 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.*;
 Object namespaceResourcePolicy;
 CfnNamespace cfnNamespace = CfnNamespace.Builder.create(this, "MyCfnNamespace")
         .namespaceName("namespaceName")
         // the properties below are optional
         .adminPasswordSecretKmsKeyId("adminPasswordSecretKmsKeyId")
         .adminUsername("adminUsername")
         .adminUserPassword("adminUserPassword")
         .dbName("dbName")
         .defaultIamRoleArn("defaultIamRoleArn")
         .finalSnapshotName("finalSnapshotName")
         .finalSnapshotRetentionPeriod(123)
         .iamRoles(List.of("iamRoles"))
         .kmsKeyId("kmsKeyId")
         .logExports(List.of("logExports"))
         .manageAdminPassword(false)
         .namespaceResourcePolicy(namespaceResourcePolicy)
         .redshiftIdcApplicationArn("redshiftIdcApplicationArn")
         .snapshotCopyConfigurations(List.of(SnapshotCopyConfigurationProperty.builder()
                 .destinationRegion("destinationRegion")
                 // the properties below are optional
                 .destinationKmsKeyId("destinationKmsKeyId")
                 .snapshotRetentionPeriod(123)
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnNamespace

      protected CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnNamespace

      protected CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnNamespace

      @Stability(Stable) public CfnNamespace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNamespaceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrNamespace

      @Stability(Stable) @NotNull public IResolvable getAttrNamespace()

    • getAttrNamespaceAdminUsername

      @Stability(Stable) @NotNull public String getAttrNamespaceAdminUsername()
      The username of the administrator for the first database created in the namespace.

    • getAttrNamespaceCreationDate

      @Stability(Stable) @NotNull public String getAttrNamespaceCreationDate()
      The date of when the namespace was created.

    • getAttrNamespaceDbName

      @Stability(Stable) @NotNull public String getAttrNamespaceDbName()
      The name of the first database created in the namespace.

    • getAttrNamespaceDefaultIamRoleArn

      @Stability(Stable) @NotNull public String getAttrNamespaceDefaultIamRoleArn()
      The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

    • getAttrNamespaceIamRoles

      @Stability(Stable) @NotNull public List<String> getAttrNamespaceIamRoles()
      A list of IAM roles to associate with the namespace.

    • getAttrNamespaceKmsKeyId

      @Stability(Stable) @NotNull public String getAttrNamespaceKmsKeyId()
      The ID of the AWS Key Management Service key used to encrypt your data.

    • getAttrNamespaceLogExports

      @Stability(Stable) @NotNull public List<String> getAttrNamespaceLogExports()
      The types of logs the namespace can export.

      Available export types are User log , Connection log , and User activity log .

    • getAttrNamespaceNamespaceArn

      @Stability(Stable) @NotNull public String getAttrNamespaceNamespaceArn()
      The Amazon Resource Name (ARN) associated with a namespace.

    • getAttrNamespaceNamespaceId

      @Stability(Stable) @NotNull public String getAttrNamespaceNamespaceId()
      The unique identifier of a namespace.

    • getAttrNamespaceNamespaceName

      @Stability(Stable) @NotNull public String getAttrNamespaceNamespaceName()
      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.

    • getAttrNamespaceStatus

      @Stability(Stable) @NotNull public String getAttrNamespaceStatus()
      The status of the namespace.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getNamespaceRef

      @Stability(Stable) @NotNull public NamespaceReference getNamespaceRef()
      A reference to a Namespace resource.
      Specified by:
      getNamespaceRef in interface INamespaceRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getNamespaceName

      @Stability(Stable) @NotNull public String getNamespaceName()
      The name of the namespace.

    • setNamespaceName

      @Stability(Stable) public void setNamespaceName(@NotNull String value)
      The name of the namespace.

    • getAdminPasswordSecretKmsKeyId

      @Stability(Stable) @Nullable public String getAdminPasswordSecretKmsKeyId()
      The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

    • setAdminPasswordSecretKmsKeyId

      @Stability(Stable) public void setAdminPasswordSecretKmsKeyId(@Nullable String value)
      The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

    • getAdminUsername

      @Stability(Stable) @Nullable public String getAdminUsername()
      The username of the administrator for the primary database created in the namespace.

    • setAdminUsername

      @Stability(Stable) public void setAdminUsername(@Nullable String value)
      The username of the administrator for the primary database created in the namespace.

    • getAdminUserPassword

      @Stability(Stable) @Nullable public String getAdminUserPassword()
      The password of the administrator for the primary database created in the namespace.

    • setAdminUserPassword

      @Stability(Stable) public void setAdminUserPassword(@Nullable String value)
      The password of the administrator for the primary database created in the namespace.

    • getDbName

      @Stability(Stable) @Nullable public String getDbName()
      The name of the primary database created in the namespace.

    • setDbName

      @Stability(Stable) public void setDbName(@Nullable String value)
      The name of the primary database created in the namespace.

    • getDefaultIamRoleArn

      @Stability(Stable) @Nullable public String getDefaultIamRoleArn()
      The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

    • setDefaultIamRoleArn

      @Stability(Stable) public void setDefaultIamRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

    • getFinalSnapshotName

      @Stability(Stable) @Nullable public String getFinalSnapshotName()
      The name of the snapshot to be created before the namespace is deleted.

    • setFinalSnapshotName

      @Stability(Stable) public void setFinalSnapshotName(@Nullable String value)
      The name of the snapshot to be created before the namespace is deleted.

    • getFinalSnapshotRetentionPeriod

      @Stability(Stable) @Nullable public Number getFinalSnapshotRetentionPeriod()
      How long to retain the final snapshot.

    • setFinalSnapshotRetentionPeriod

      @Stability(Stable) public void setFinalSnapshotRetentionPeriod(@Nullable Number value)
      How long to retain the final snapshot.

    • getIamRoles

      @Stability(Stable) @Nullable public List<String> getIamRoles()
      A list of IAM roles to associate with the namespace.

    • setIamRoles

      @Stability(Stable) public void setIamRoles(@Nullable List<String> value)
      A list of IAM roles to associate with the namespace.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ID of the AWS Key Management Service key used to encrypt your data.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ID of the AWS Key Management Service key used to encrypt your data.

    • getLogExports

      @Stability(Stable) @Nullable public List<String> getLogExports()
      The types of logs the namespace can export.

    • setLogExports

      @Stability(Stable) public void setLogExports(@Nullable List<String> value)
      The types of logs the namespace can export.

    • getManageAdminPassword

      @Stability(Stable) @Nullable public Object getManageAdminPassword()
      If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.

      Returns union: either Boolean or IResolvable

    • setManageAdminPassword

      @Stability(Stable) public void setManageAdminPassword(@Nullable Boolean value)
      If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.

    • setManageAdminPassword

      @Stability(Stable) public void setManageAdminPassword(@Nullable IResolvable value)
      If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.

    • getNamespaceResourcePolicy

      @Stability(Stable) @Nullable public Object getNamespaceResourcePolicy()
      The resource policy that will be attached to the namespace.

    • setNamespaceResourcePolicy

      @Stability(Stable) public void setNamespaceResourcePolicy(@Nullable Object value)
      The resource policy that will be attached to the namespace.

    • getRedshiftIdcApplicationArn

      @Stability(Stable) @Nullable public String getRedshiftIdcApplicationArn()
      The ARN for the Redshift application that integrates with IAM Identity Center.

    • setRedshiftIdcApplicationArn

      @Stability(Stable) public void setRedshiftIdcApplicationArn(@Nullable String value)
      The ARN for the Redshift application that integrates with IAM Identity Center.

    • getSnapshotCopyConfigurations

      @Stability(Stable) @Nullable public Object getSnapshotCopyConfigurations()
      The snapshot copy configurations for the namespace.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNamespace.SnapshotCopyConfigurationProperty>

    • setSnapshotCopyConfigurations

      @Stability(Stable) public void setSnapshotCopyConfigurations(@Nullable IResolvable value)
      The snapshot copy configurations for the namespace.

    • setSnapshotCopyConfigurations

      @Stability(Stable) public void setSnapshotCopyConfigurations(@Nullable List<Object> value)
      The snapshot copy configurations for the namespace.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The map of the key-value pairs used to tag the namespace.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The map of the key-value pairs used to tag the namespace.