software.amazon.awscdk.services.redshiftserverless

Interface CfnNamespaceProps

All Known Implementing Classes:

CfnNamespaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:49.829Z")
public interface CfnNamespaceProps

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"))
         .namespace(NamespaceProperty.builder()
                 .adminUsername("adminUsername")
                 .creationDate("creationDate")
                 .dbName("dbName")
                 .defaultIamRoleArn("defaultIamRoleArn")
                 .iamRoles(List.of("iamRoles"))
                 .kmsKeyId("kmsKeyId")
                 .logExports(List.of("logExports"))
                 .namespaceArn("namespaceArn")
                 .namespaceId("namespaceId")
                 .namespaceName("namespaceName")
                 .status("status")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnNamespaceProps.Builder A builder for CfnNamespaceProps
static class	CfnNamespaceProps.Jsii$Proxy An implementation for CfnNamespaceProps

Method Summary

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

Method Detail

getNamespaceName

java.lang.String getNamespaceName()

The name of the namespace.

getAdminUsername

default java.lang.String getAdminUsername()

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

getAdminUserPassword

default java.lang.String getAdminUserPassword()

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

getDbName

default java.lang.String getDbName()

The name of the primary database created in the namespace.

getDefaultIamRoleArn

default java.lang.String getDefaultIamRoleArn()

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

getFinalSnapshotName

default java.lang.String getFinalSnapshotName()

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

getFinalSnapshotRetentionPeriod

default java.lang.Number getFinalSnapshotRetentionPeriod()

How long to retain the final snapshot.

getIamRoles

default java.util.List<java.lang.String> getIamRoles()

A list of IAM roles to associate with the namespace.

getKmsKeyId

default java.lang.String getKmsKeyId()

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

getLogExports

default java.util.List<java.lang.String> getLogExports()

The types of logs the namespace can export.

Available export types are userlog , connectionlog , and useractivitylog .

getNamespace

default java.lang.Object getNamespace()

`AWS::RedshiftServerless::Namespace.Namespace`.

getTags

default java.util.List<CfnTag> getTags()

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

builder

static CfnNamespaceProps.Builder builder()

Returns:

a CfnNamespaceProps.Builder of CfnNamespaceProps