Package software.amazon.awscdk.services.redshiftserverless

Class CfnNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.redshiftserverless.CfnNamespace
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.896Z") @Stability(Stable) public class CfnNamespace extends CfnResource implements IInspectable
A CloudFormation AWS::RedshiftServerless::Namespace.

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

  • 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 Construct scope, @NotNull String id, @NotNull CfnNamespaceProps props)
      Create a new AWS::RedshiftServerless::Namespace.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The map of the key-value pairs used to tag the namespace.

    • getNamespaceName

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

    • setNamespaceName

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

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

      Available export types are userlog , connectionlog , and useractivitylog .

    • setLogExports

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

      Available export types are userlog , connectionlog , and useractivitylog .