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.98.0 (build 00b106d)",
           date="2024-05-08T21:35:12.809Z")
@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.*;
 Object namespaceResourcePolicy;
 CfnNamespaceProps cfnNamespaceProps = CfnNamespaceProps.builder()
         .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	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	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 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.
default Object	getManageAdminPassword()	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
String	getNamespaceName()	The name of the namespace.
default Object	getNamespaceResourcePolicy()	The resource policy that will be attached to the namespace.
default String	getRedshiftIdcApplicationArn()	The ARN for the Redshift application that integrates with IAM Identity Center.
default Object	getSnapshotCopyConfigurations()	The snapshot copy configurations for 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.

See Also:

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

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.

You can only use this parameter if ManageAdminPassword is true .

See Also:

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

getAdminUsername

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

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

See Also:

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

getAdminUserPassword

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

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

See Also:

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

getDbName

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

The name of the primary database created in the namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-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-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-defaultiamrolearn

getFinalSnapshotName

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

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

See Also:

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

getFinalSnapshotRetentionPeriod

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

How long to retain the final snapshot.

See Also:

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

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-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-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-resource-redshiftserverless-namespace.html#cfn-redshiftserverless-namespace-kmskeyid

getLogExports

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

The types of logs the namespace can export.

Available export types are userlog , connectionlog , and useractivitylog .

See Also:

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

getManageAdminPassword

@Stability(Stable)
@Nullable
default Object getManageAdminPassword()

If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.

You can't use AdminUserPassword if ManageAdminPassword is true. If ManageAdminPassword is false or not set, Amazon Redshift uses AdminUserPassword for the admin user account's password.

See Also:

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

getNamespaceResourcePolicy

@Stability(Stable)
@Nullable
default Object getNamespaceResourcePolicy()

The resource policy that will be attached to the namespace.

See Also:

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

getRedshiftIdcApplicationArn

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

The ARN for the Redshift application that integrates with IAM Identity Center.

See Also:

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

getSnapshotCopyConfigurations

@Stability(Stable)
@Nullable
default Object getSnapshotCopyConfigurations()

The snapshot copy configurations for the namespace.

See Also:

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

getTags

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

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

See Also:

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

builder

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

Returns:

a CfnNamespaceProps.Builder of CfnNamespaceProps