Class CfnNamespacePropsMixin.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.redshiftserverless.CfnNamespacePropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnNamespacePropsMixin>
- Enclosing class:
CfnNamespacePropsMixin
@Stability(Stable)
public static final class CfnNamespacePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNamespacePropsMixin>
A fluent builder for
CfnNamespacePropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionadminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.adminUsername(String adminUsername) The username of the administrator for the primary database created in the namespace.adminUserPassword(String adminUserPassword) The password of the administrator for the primary database created in the namespace.build()create()create(CfnPropertyMixinOptions options) The name of the primary database created in the namespace.defaultIamRoleArn(String defaultIamRoleArn) The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.defaultIamRoleArn(IRoleRef defaultIamRoleArn) The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.finalSnapshotName(String finalSnapshotName) The name of the snapshot to be created before the namespace is deleted.finalSnapshotRetentionPeriod(Number finalSnapshotRetentionPeriod) How long to retain the final snapshot.A list of IAM roles to associate with the namespace.The ID of the AWS Key Management Service key used to encrypt your data.The ID of the AWS Key Management Service key used to encrypt your data.logExports(List<String> logExports) The types of logs the namespace can export.manageAdminPassword(Boolean manageAdminPassword) If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.manageAdminPassword(IResolvable manageAdminPassword) If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.namespaceName(String namespaceName) The name of the namespace.namespaceResourcePolicy(Object namespaceResourcePolicy) The resource policy that will be attached to the namespace.redshiftIdcApplicationArn(String redshiftIdcApplicationArn) The ARN for the Redshift application that integrates with IAM Identity Center.snapshotCopyConfigurations(List<? extends Object> snapshotCopyConfigurations) The snapshot copy configurations for the namespace.snapshotCopyConfigurations(IResolvable snapshotCopyConfigurations) The snapshot copy configurations for the namespace.The map of the key-value pairs used to tag the namespace.
-
Method Details
-
create
@Stability(Stable) public static CfnNamespacePropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnNamespacePropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnNamespacePropsMixin.Builder.
-
adminPasswordSecretKmsKeyId
@Stability(Stable) public CfnNamespacePropsMixin.Builder adminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) 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
ManageAdminPasswordistrue.- Parameters:
adminPasswordSecretKmsKeyId- The ID of the AWS Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. This parameter is required.- Returns:
this- See Also:
-
adminUsername
The username of the administrator for the primary database created in the namespace.- Parameters:
adminUsername- The username of the administrator for the primary database created in the namespace. This parameter is required.- Returns:
this- See Also:
-
adminUserPassword
@Stability(Stable) public CfnNamespacePropsMixin.Builder adminUserPassword(String adminUserPassword) The password of the administrator for the primary database created in the namespace.- Parameters:
adminUserPassword- The password of the administrator for the primary database created in the namespace. This parameter is required.- Returns:
this- See Also:
-
dbName
The name of the primary database created in the namespace.- Parameters:
dbName- The name of the primary database created in the namespace. This parameter is required.- Returns:
this- See Also:
-
defaultIamRoleArn
@Stability(Stable) public CfnNamespacePropsMixin.Builder defaultIamRoleArn(String defaultIamRoleArn) The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.- Parameters:
defaultIamRoleArn- The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter is required.- Returns:
this- See Also:
-
defaultIamRoleArn
@Stability(Stable) public CfnNamespacePropsMixin.Builder defaultIamRoleArn(IRoleRef defaultIamRoleArn) The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.- Parameters:
defaultIamRoleArn- The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter is required.- Returns:
this- See Also:
-
finalSnapshotName
@Stability(Stable) public CfnNamespacePropsMixin.Builder finalSnapshotName(String finalSnapshotName) The name of the snapshot to be created before the namespace is deleted.- Parameters:
finalSnapshotName- The name of the snapshot to be created before the namespace is deleted. This parameter is required.- Returns:
this- See Also:
-
finalSnapshotRetentionPeriod
@Stability(Stable) public CfnNamespacePropsMixin.Builder finalSnapshotRetentionPeriod(Number finalSnapshotRetentionPeriod) How long to retain the final snapshot.- Parameters:
finalSnapshotRetentionPeriod- How long to retain the final snapshot. This parameter is required.- Returns:
this- See Also:
-
iamRoles
A list of IAM roles to associate with the namespace.- Parameters:
iamRoles- A list of IAM roles to associate with the namespace. This parameter is required.- Returns:
this- See Also:
-
kmsKeyId
The ID of the AWS Key Management Service key used to encrypt your data.- Parameters:
kmsKeyId- The ID of the AWS Key Management Service key used to encrypt your data. This parameter is required.- Returns:
this- See Also:
-
kmsKeyId
The ID of the AWS Key Management Service key used to encrypt your data.- Parameters:
kmsKeyId- The ID of the AWS Key Management Service key used to encrypt your data. This parameter is required.- Returns:
this- See Also:
-
logExports
The types of logs the namespace can export.Available export types are
userlog,connectionlog, anduseractivitylog.- Parameters:
logExports- The types of logs the namespace can export. This parameter is required.- Returns:
this- See Also:
-
manageAdminPassword
@Stability(Stable) public CfnNamespacePropsMixin.Builder manageAdminPassword(Boolean manageAdminPassword) If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.You can't use
AdminUserPasswordifManageAdminPasswordis true. IfManageAdminPasswordisfalseor not set, Amazon Redshift usesAdminUserPasswordfor the admin user account's password.- Parameters:
manageAdminPassword- If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. This parameter is required.- Returns:
this- See Also:
-
manageAdminPassword
@Stability(Stable) public CfnNamespacePropsMixin.Builder manageAdminPassword(IResolvable manageAdminPassword) If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.You can't use
AdminUserPasswordifManageAdminPasswordis true. IfManageAdminPasswordisfalseor not set, Amazon Redshift usesAdminUserPasswordfor the admin user account's password.- Parameters:
manageAdminPassword- If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. This parameter is required.- Returns:
this- See Also:
-
namespaceName
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.
- Parameters:
namespaceName- The name of the namespace. This parameter is required.- Returns:
this- See Also:
-
namespaceResourcePolicy
@Stability(Stable) public CfnNamespacePropsMixin.Builder namespaceResourcePolicy(Object namespaceResourcePolicy) The resource policy that will be attached to the namespace.- Parameters:
namespaceResourcePolicy- The resource policy that will be attached to the namespace. This parameter is required.- Returns:
this- See Also:
-
redshiftIdcApplicationArn
@Stability(Stable) public CfnNamespacePropsMixin.Builder redshiftIdcApplicationArn(String redshiftIdcApplicationArn) The ARN for the Redshift application that integrates with IAM Identity Center.- Parameters:
redshiftIdcApplicationArn- The ARN for the Redshift application that integrates with IAM Identity Center. This parameter is required.- Returns:
this- See Also:
-
snapshotCopyConfigurations
@Stability(Stable) public CfnNamespacePropsMixin.Builder snapshotCopyConfigurations(IResolvable snapshotCopyConfigurations) The snapshot copy configurations for the namespace.- Parameters:
snapshotCopyConfigurations- The snapshot copy configurations for the namespace. This parameter is required.- Returns:
this- See Also:
-
snapshotCopyConfigurations
@Stability(Stable) public CfnNamespacePropsMixin.Builder snapshotCopyConfigurations(List<? extends Object> snapshotCopyConfigurations) The snapshot copy configurations for the namespace.- Parameters:
snapshotCopyConfigurations- The snapshot copy configurations for the namespace. This parameter is required.- Returns:
this- See Also:
-
tags
The map of the key-value pairs used to tag the namespace.- Parameters:
tags- The map of the key-value pairs used to tag the namespace. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnNamespacePropsMixin>- Returns:
- a newly built instance of
CfnNamespacePropsMixin.
-