Package software.amazon.awscdk.services.redshiftserverless

Interface CfnNamespace.NamespaceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNamespace.NamespaceProperty.Jsii$Proxy

Enclosing class:

CfnNamespace

@Stability(Stable)
public static interface CfnNamespace.NamespaceProperty
extends software.amazon.jsii.JsiiSerializable

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.*;
 NamespaceProperty namespaceProperty = NamespaceProperty.builder()
         .adminPasswordSecretArn("adminPasswordSecretArn")
         .adminPasswordSecretKmsKeyId("adminPasswordSecretKmsKeyId")
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnNamespace.NamespaceProperty.Builder	builder()
default String	getAdminPasswordSecretArn()	The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
default String	getAdminPasswordSecretKmsKeyId()	The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
default String	getAdminUsername()	The username of the administrator for the first database created in the namespace.
default String	getCreationDate()	The date of when the namespace was created.
default String	getDbName()	The name of the first 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 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.
default String	getNamespaceArn()	The Amazon Resource Name (ARN) associated with a namespace.
default String	getNamespaceId()	The unique identifier of a namespace.
default String	getNamespaceName()	The name of the namespace.
default String	getStatus()	The status of the namespace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdminPasswordSecretArn

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

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretarn

getAdminPasswordSecretKmsKeyId

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

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminpasswordsecretkmskeyid

getAdminUsername

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-adminusername

getCreationDate

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

The date of when the namespace was created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-creationdate

getDbName

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

The name of the first database created in the namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-dbname

getDefaultIamRoleArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-defaultiamrolearn

getIamRoles

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

A list of IAM roles to associate with the namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-iamroles

getKmsKeyId

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-kmskeyid

getLogExports

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

The types of logs the namespace can export.

Available export types are User log, Connection log, and User activity log.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-logexports

getNamespaceArn

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

The Amazon Resource Name (ARN) associated with a namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacearn

getNamespaceId

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

The unique identifier of a namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespaceid

getNamespaceName

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-namespacename

getStatus

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

The status of the namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-namespace-namespace.html#cfn-redshiftserverless-namespace-namespace-status

builder

@Stability(Stable)
static CfnNamespace.NamespaceProperty.Builder builder()

Returns:

a CfnNamespace.NamespaceProperty.Builder of CfnNamespace.NamespaceProperty