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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:15.015Z")
@Stability(Stable)
public class CfnNamespace
extends CfnResource
implements IInspectable, 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnNamespace.Builder	A fluent builder for CfnNamespace.
static interface	CfnNamespace.NamespaceProperty	A collection of database objects and users.
static interface	CfnNamespace.SnapshotCopyConfigurationProperty	The object that you configure to copy snapshots from one namespace to a namespace in another AWS Region .

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef)
	CfnNamespace(software.constructs.Construct scope, String id, CfnNamespaceProps props)

Method Summary

Modifier and Type	Method	Description
String	getAdminPasswordSecretKmsKeyId()	The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
String	getAdminUsername()	The username of the administrator for the primary database created in the namespace.
String	getAdminUserPassword()	The password of the administrator for the primary database created in the namespace.
IResolvable	getAttrNamespace()
String	getAttrNamespaceAdminUsername()	The username of the administrator for the first database created in the namespace.
String	getAttrNamespaceCreationDate()	The date of when the namespace was created.
String	getAttrNamespaceDbName()	The name of the first database created in the namespace.
String	getAttrNamespaceDefaultIamRoleArn()	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
List<String>	getAttrNamespaceIamRoles()	A list of IAM roles to associate with the namespace.
String	getAttrNamespaceKmsKeyId()	The ID of the AWS Key Management Service key used to encrypt your data.
List<String>	getAttrNamespaceLogExports()	The types of logs the namespace can export.
String	getAttrNamespaceNamespaceArn()	The Amazon Resource Name (ARN) associated with a namespace.
String	getAttrNamespaceNamespaceId()	The unique identifier of a namespace.
String	getAttrNamespaceNamespaceName()	The name of the namespace.
String	getAttrNamespaceStatus()	The status of the namespace.
protected Map<String,Object>	getCfnProperties()
String	getDbName()	The name of the primary database created in the namespace.
String	getDefaultIamRoleArn()	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
String	getFinalSnapshotName()	The name of the snapshot to be created before the namespace is deleted.
Number	getFinalSnapshotRetentionPeriod()	How long to retain the final snapshot.
List<String>	getIamRoles()	A list of IAM roles to associate with the namespace.
String	getKmsKeyId()	The ID of the AWS Key Management Service key used to encrypt your data.
List<String>	getLogExports()	The types of logs the namespace can export.
Object	getManageAdminPassword()	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
String	getNamespaceName()	The name of the namespace.
Object	getNamespaceResourcePolicy()	The resource policy that will be attached to the namespace.
String	getRedshiftIdcApplicationArn()	The ARN for the Redshift application that integrates with IAM Identity Center.
Object	getSnapshotCopyConfigurations()	The snapshot copy configurations for the namespace.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The map of the key-value pairs used to tag the namespace.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdminPasswordSecretKmsKeyId(String value)	The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
void	setAdminUsername(String value)	The username of the administrator for the primary database created in the namespace.
void	setAdminUserPassword(String value)	The password of the administrator for the primary database created in the namespace.
void	setDbName(String value)	The name of the primary database created in the namespace.
void	setDefaultIamRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
void	setFinalSnapshotName(String value)	The name of the snapshot to be created before the namespace is deleted.
void	setFinalSnapshotRetentionPeriod(Number value)	How long to retain the final snapshot.
void	setIamRoles(List<String> value)	A list of IAM roles to associate with the namespace.
void	setKmsKeyId(String value)	The ID of the AWS Key Management Service key used to encrypt your data.
void	setLogExports(List<String> value)	The types of logs the namespace can export.
void	setManageAdminPassword(Boolean value)	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
void	setManageAdminPassword(IResolvable value)	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
void	setNamespaceName(String value)	The name of the namespace.
void	setNamespaceResourcePolicy(Object value)	The resource policy that will be attached to the namespace.
void	setRedshiftIdcApplicationArn(String value)	The ARN for the Redshift application that integrates with IAM Identity Center.
void	setSnapshotCopyConfigurations(List<Object> value)	The snapshot copy configurations for the namespace.
void	setSnapshotCopyConfigurations(IResolvable value)	The snapshot copy configurations for the namespace.
void	setTagsRaw(List<CfnTag> value)	The map of the key-value pairs used to tag the namespace.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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.

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.

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.