Package software.amazon.awscdk.services.redshiftserverless

Interface CfnNamespaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNamespaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:34.899Z")
@Stability(Stable)
public interface CfnNamespaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnNamespace.

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.*;
 CfnNamespaceProps cfnNamespaceProps = CfnNamespaceProps.builder()
         .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	Interface	Description
static final class	CfnNamespaceProps.Builder	A builder for CfnNamespaceProps
static final class	CfnNamespaceProps.Jsii$Proxy	An implementation for CfnNamespaceProps

Method Summary

Modifier and Type	Method	Description
static CfnNamespaceProps.Builder	builder()
default String	getAdminUsername()	The username of the administrator for the primary database created in the namespace.
default String	getAdminUserPassword()	The password of the administrator for the primary database created in the namespace.
default String	getDbName()	The name of the primary database created in the namespace.
default String	getDefaultIamRoleArn()	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
default String	getFinalSnapshotName()	The name of the snapshot to be created before the namespace is deleted.
default Number	getFinalSnapshotRetentionPeriod()	How long to retain the final snapshot.
default List<String>	getIamRoles()	A list of IAM roles to associate with the namespace.
default String	getKmsKeyId()	The ID of the AWS Key Management Service key used to encrypt your data.
default List<String>	getLogExports()	The types of logs the namespace can export.
String	getNamespaceName()	The name of the namespace.
default List<CfnTag>	getTags()	The map of the key-value pairs used to tag the namespace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNamespaceName

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

getAdminUsername

@Stability(Stable)
@Nullable
default String getAdminUsername()

The username of the administrator for the primary database created in the namespace.

getAdminUserPassword

@Stability(Stable)
@Nullable
default String getAdminUserPassword()

The password of the administrator for the primary database created in the namespace.

getDbName

@Stability(Stable)
@Nullable
default String getDbName()

The name of the primary database created in the namespace.

getDefaultIamRoleArn

@Stability(Stable)
@Nullable
default String getDefaultIamRoleArn()

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

getFinalSnapshotName

@Stability(Stable)
@Nullable
default String getFinalSnapshotName()

The name of the snapshot to be created before the namespace is deleted.

getFinalSnapshotRetentionPeriod

@Stability(Stable)
@Nullable
default Number getFinalSnapshotRetentionPeriod()

How long to retain the final snapshot.

getIamRoles

@Stability(Stable)
@Nullable
default List<String> getIamRoles()

A list of IAM roles to associate with the namespace.

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The ID of the AWS Key Management Service key used to encrypt your data.

getLogExports

@Stability(Stable)
@Nullable
default List<String> getLogExports()

The types of logs the namespace can export.

Available export types are userlog , connectionlog , and useractivitylog .

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The map of the key-value pairs used to tag the namespace.

builder

@Stability(Stable)
static CfnNamespaceProps.Builder builder()

Returns:

a CfnNamespaceProps.Builder of CfnNamespaceProps