CfnNamespace

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.476Z")
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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnNamespace.Builder` A fluent builder for `CfnNamespace`.
`static interface`	`CfnNamespace.NamespaceProperty` A collection of database objects and users.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnNamespace(Construct scope, java.lang.String id, CfnNamespaceProps props)` Create a new `AWS::RedshiftServerless::Namespace`.
`protected`	`CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAdminUsername()` The username of the administrator for the primary database created in the namespace.
`java.lang.String`	`getAdminUserPassword()` The password of the administrator for the primary database created in the namespace.
`java.lang.String`	`getAttrNamespaceAdminUsername()` The username of the administrator for the first database created in the namespace.
`java.lang.String`	`getAttrNamespaceCreationDate()` The date of when the namespace was created.
`java.lang.String`	`getAttrNamespaceDbName()` The name of the first database created in the namespace.
`java.lang.String`	`getAttrNamespaceDefaultIamRoleArn()` The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
`java.util.List<java.lang.String>`	`getAttrNamespaceIamRoles()` A list of IAM roles to associate with the namespace.
`java.lang.String`	`getAttrNamespaceKmsKeyId()` The ID of the AWS Key Management Service key used to encrypt your data.
`java.util.List<java.lang.String>`	`getAttrNamespaceLogExports()` The types of logs the namespace can export.
`java.lang.String`	`getAttrNamespaceNamespaceArn()` The Amazon Resource Name (ARN) associated with a namespace.
`java.lang.String`	`getAttrNamespaceNamespaceId()` The unique identifier of a namespace.
`java.lang.String`	`getAttrNamespaceNamespaceName()` The name of the namespace.
`java.lang.String`	`getAttrNamespaceStatus()` The status of the namespace.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDbName()` The name of the primary database created in the namespace.
`java.lang.String`	`getDefaultIamRoleArn()` The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
`java.lang.String`	`getFinalSnapshotName()` The name of the snapshot to be created before the namespace is deleted.
`java.lang.Number`	`getFinalSnapshotRetentionPeriod()` How long to retain the final snapshot.
`java.util.List<java.lang.String>`	`getIamRoles()` A list of IAM roles to associate with the namespace.
`java.lang.String`	`getKmsKeyId()` The ID of the AWS Key Management Service key used to encrypt your data.
`java.util.List<java.lang.String>`	`getLogExports()` The types of logs the namespace can export.
`java.lang.String`	`getNamespaceName()` The name of the namespace.
`TagManager`	`getTags()` The map of the key-value pairs used to tag the namespace.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAdminUsername(java.lang.String value)` The username of the administrator for the primary database created in the namespace.
`void`	`setAdminUserPassword(java.lang.String value)` The password of the administrator for the primary database created in the namespace.
`void`	`setDbName(java.lang.String value)` The name of the primary database created in the namespace.
`void`	`setDefaultIamRoleArn(java.lang.String value)` The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
`void`	`setFinalSnapshotName(java.lang.String value)` The name of the snapshot to be created before the namespace is deleted.
`void`	`setFinalSnapshotRetentionPeriod(java.lang.Number value)` How long to retain the final snapshot.
`void`	`setIamRoles(java.util.List<java.lang.String> value)` A list of IAM roles to associate with the namespace.
`void`	`setKmsKeyId(java.lang.String value)` The ID of the AWS Key Management Service key used to encrypt your data.
`void`	`setLogExports(java.util.List<java.lang.String> value)` The types of logs the namespace can export.
`void`	`setNamespaceName(java.lang.String value)` The name of the namespace.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnNamespace
```
protected CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnNamespace
```
protected CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnNamespace
```
public CfnNamespace(Construct scope,
                    java.lang.String id,
                    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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrNamespaceAdminUsername
```
public java.lang.String getAttrNamespaceAdminUsername()
```
    The username of the administrator for the first database created in the namespace.
  - getAttrNamespaceCreationDate
```
public java.lang.String getAttrNamespaceCreationDate()
```
    The date of when the namespace was created.
  - getAttrNamespaceDbName
```
public java.lang.String getAttrNamespaceDbName()
```
    The name of the first database created in the namespace.
  - getAttrNamespaceDefaultIamRoleArn
```
public java.lang.String getAttrNamespaceDefaultIamRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
  - getAttrNamespaceIamRoles
```
public java.util.List<java.lang.String> getAttrNamespaceIamRoles()
```
    A list of IAM roles to associate with the namespace.
  - getAttrNamespaceKmsKeyId
```
public java.lang.String getAttrNamespaceKmsKeyId()
```
    The ID of the AWS Key Management Service key used to encrypt your data.
  - getAttrNamespaceLogExports
```
public java.util.List<java.lang.String> getAttrNamespaceLogExports()
```
    The types of logs the namespace can export.
    Available export types are User log , Connection log , and User activity log .
  - getAttrNamespaceNamespaceArn
```
public java.lang.String getAttrNamespaceNamespaceArn()
```
    The Amazon Resource Name (ARN) associated with a namespace.
  - getAttrNamespaceNamespaceId
```
public java.lang.String getAttrNamespaceNamespaceId()
```
    The unique identifier of a namespace.
  - getAttrNamespaceNamespaceName
```
public java.lang.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
```
public java.lang.String getAttrNamespaceStatus()
```
    The status of the namespace.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The map of the key-value pairs used to tag the namespace.
  - getNamespaceName
```
public java.lang.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
```
public void setNamespaceName(java.lang.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
```
public java.lang.String getAdminUsername()
```
    The username of the administrator for the primary database created in the namespace.
  - setAdminUsername
```
public void setAdminUsername(java.lang.String value)
```
    The username of the administrator for the primary database created in the namespace.
  - getAdminUserPassword
```
public java.lang.String getAdminUserPassword()
```
    The password of the administrator for the primary database created in the namespace.
  - setAdminUserPassword
```
public void setAdminUserPassword(java.lang.String value)
```
    The password of the administrator for the primary database created in the namespace.
  - getDbName
```
public java.lang.String getDbName()
```
    The name of the primary database created in the namespace.
  - setDbName
```
public void setDbName(java.lang.String value)
```
    The name of the primary database created in the namespace.
  - getDefaultIamRoleArn
```
public java.lang.String getDefaultIamRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
  - setDefaultIamRoleArn
```
public void setDefaultIamRoleArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
  - getFinalSnapshotName
```
public java.lang.String getFinalSnapshotName()
```
    The name of the snapshot to be created before the namespace is deleted.
  - setFinalSnapshotName
```
public void setFinalSnapshotName(java.lang.String value)
```
    The name of the snapshot to be created before the namespace is deleted.
  - getFinalSnapshotRetentionPeriod
```
public java.lang.Number getFinalSnapshotRetentionPeriod()
```
    How long to retain the final snapshot.
  - setFinalSnapshotRetentionPeriod
```
public void setFinalSnapshotRetentionPeriod(java.lang.Number value)
```
    How long to retain the final snapshot.
  - getIamRoles
```
public java.util.List<java.lang.String> getIamRoles()
```
    A list of IAM roles to associate with the namespace.
  - setIamRoles
```
public void setIamRoles(java.util.List<java.lang.String> value)
```
    A list of IAM roles to associate with the namespace.
  - getKmsKeyId
```
public java.lang.String getKmsKeyId()
```
    The ID of the AWS Key Management Service key used to encrypt your data.
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String value)
```
    The ID of the AWS Key Management Service key used to encrypt your data.
  - getLogExports
```
public java.util.List<java.lang.String> getLogExports()
```
    The types of logs the namespace can export.
    Available export types are userlog , connectionlog , and useractivitylog .
  - setLogExports
```
public void setLogExports(java.util.List<java.lang.String> value)
```
    The types of logs the namespace can export.
    Available export types are userlog , connectionlog , and useractivitylog .

Class CfnNamespace

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnNamespace

CfnNamespace

CfnNamespace

Method Detail

inspect

renderProperties

getAttrNamespaceAdminUsername

getAttrNamespaceCreationDate

getAttrNamespaceDbName

getAttrNamespaceDefaultIamRoleArn

getAttrNamespaceIamRoles

getAttrNamespaceKmsKeyId

getAttrNamespaceLogExports

getAttrNamespaceNamespaceArn

getAttrNamespaceNamespaceId

getAttrNamespaceNamespaceName

getAttrNamespaceStatus

getCfnProperties

getTags

getNamespaceName

setNamespaceName

getAdminUsername

setAdminUsername

getAdminUserPassword

setAdminUserPassword

getDbName

setDbName

getDefaultIamRoleArn

setDefaultIamRoleArn

getFinalSnapshotName

setFinalSnapshotName

getFinalSnapshotRetentionPeriod

setFinalSnapshotRetentionPeriod

getIamRoles

setIamRoles

getKmsKeyId

setKmsKeyId

getLogExports

setLogExports