Class CfnNamespaceProps.Builder
java.lang.Object
software.amazon.awscdk.services.redshiftserverless.CfnNamespaceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnNamespaceProps>
- Enclosing interface:
CfnNamespaceProps
@Stability(Stable)
public static final class CfnNamespaceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNamespaceProps>
A builder for
CfnNamespaceProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadminPasswordSecretKmsKeyId
(String adminPasswordSecretKmsKeyId) Sets the value ofCfnNamespaceProps.getAdminPasswordSecretKmsKeyId()
adminUsername
(String adminUsername) Sets the value ofCfnNamespaceProps.getAdminUsername()
adminUserPassword
(String adminUserPassword) Sets the value ofCfnNamespaceProps.getAdminUserPassword()
build()
Builds the configured instance.Sets the value ofCfnNamespaceProps.getDbName()
defaultIamRoleArn
(String defaultIamRoleArn) Sets the value ofCfnNamespaceProps.getDefaultIamRoleArn()
finalSnapshotName
(String finalSnapshotName) Sets the value ofCfnNamespaceProps.getFinalSnapshotName()
finalSnapshotRetentionPeriod
(Number finalSnapshotRetentionPeriod) Sets the value ofCfnNamespaceProps.getFinalSnapshotRetentionPeriod()
Sets the value ofCfnNamespaceProps.getIamRoles()
Sets the value ofCfnNamespaceProps.getKmsKeyId()
logExports
(List<String> logExports) Sets the value ofCfnNamespaceProps.getLogExports()
manageAdminPassword
(Boolean manageAdminPassword) Sets the value ofCfnNamespaceProps.getManageAdminPassword()
manageAdminPassword
(IResolvable manageAdminPassword) Sets the value ofCfnNamespaceProps.getManageAdminPassword()
namespaceName
(String namespaceName) Sets the value ofCfnNamespaceProps.getNamespaceName()
namespaceResourcePolicy
(Object namespaceResourcePolicy) Sets the value ofCfnNamespaceProps.getNamespaceResourcePolicy()
redshiftIdcApplicationArn
(String redshiftIdcApplicationArn) Sets the value ofCfnNamespaceProps.getRedshiftIdcApplicationArn()
snapshotCopyConfigurations
(List<? extends Object> snapshotCopyConfigurations) Sets the value ofCfnNamespaceProps.getSnapshotCopyConfigurations()
snapshotCopyConfigurations
(IResolvable snapshotCopyConfigurations) Sets the value ofCfnNamespaceProps.getSnapshotCopyConfigurations()
Sets the value ofCfnNamespaceProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
namespaceName
Sets the value ofCfnNamespaceProps.getNamespaceName()
- Parameters:
namespaceName
- The name of the namespace. This parameter is required. 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.- Returns:
this
-
adminPasswordSecretKmsKeyId
@Stability(Stable) public CfnNamespaceProps.Builder adminPasswordSecretKmsKeyId(String adminPasswordSecretKmsKeyId) Sets the value ofCfnNamespaceProps.getAdminPasswordSecretKmsKeyId()
- Parameters:
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 ifManageAdminPassword
istrue
.- Returns:
this
-
adminUsername
Sets the value ofCfnNamespaceProps.getAdminUsername()
- Parameters:
adminUsername
- The username of the administrator for the primary database created in the namespace.- Returns:
this
-
adminUserPassword
Sets the value ofCfnNamespaceProps.getAdminUserPassword()
- Parameters:
adminUserPassword
- The password of the administrator for the primary database created in the namespace.- Returns:
this
-
dbName
Sets the value ofCfnNamespaceProps.getDbName()
- Parameters:
dbName
- The name of the primary database created in the namespace.- Returns:
this
-
defaultIamRoleArn
Sets the value ofCfnNamespaceProps.getDefaultIamRoleArn()
- Parameters:
defaultIamRoleArn
- The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.- Returns:
this
-
finalSnapshotName
Sets the value ofCfnNamespaceProps.getFinalSnapshotName()
- Parameters:
finalSnapshotName
- The name of the snapshot to be created before the namespace is deleted.- Returns:
this
-
finalSnapshotRetentionPeriod
@Stability(Stable) public CfnNamespaceProps.Builder finalSnapshotRetentionPeriod(Number finalSnapshotRetentionPeriod) Sets the value ofCfnNamespaceProps.getFinalSnapshotRetentionPeriod()
- Parameters:
finalSnapshotRetentionPeriod
- How long to retain the final snapshot.- Returns:
this
-
iamRoles
Sets the value ofCfnNamespaceProps.getIamRoles()
- Parameters:
iamRoles
- A list of IAM roles to associate with the namespace.- Returns:
this
-
kmsKeyId
Sets the value ofCfnNamespaceProps.getKmsKeyId()
- Parameters:
kmsKeyId
- The ID of the AWS Key Management Service key used to encrypt your data.- Returns:
this
-
logExports
Sets the value ofCfnNamespaceProps.getLogExports()
- Parameters:
logExports
- The types of logs the namespace can export. Available export types areuserlog
,connectionlog
, anduseractivitylog
.- Returns:
this
-
manageAdminPassword
@Stability(Stable) public CfnNamespaceProps.Builder manageAdminPassword(Boolean manageAdminPassword) Sets the value ofCfnNamespaceProps.getManageAdminPassword()
- Parameters:
manageAdminPassword
- If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't useAdminUserPassword
ifManageAdminPassword
is true. IfManageAdminPassword
isfalse
or not set, Amazon Redshift usesAdminUserPassword
for the admin user account's password.- Returns:
this
-
manageAdminPassword
@Stability(Stable) public CfnNamespaceProps.Builder manageAdminPassword(IResolvable manageAdminPassword) Sets the value ofCfnNamespaceProps.getManageAdminPassword()
- Parameters:
manageAdminPassword
- If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials. You can't useAdminUserPassword
ifManageAdminPassword
is true. IfManageAdminPassword
isfalse
or not set, Amazon Redshift usesAdminUserPassword
for the admin user account's password.- Returns:
this
-
namespaceResourcePolicy
@Stability(Stable) public CfnNamespaceProps.Builder namespaceResourcePolicy(Object namespaceResourcePolicy) Sets the value ofCfnNamespaceProps.getNamespaceResourcePolicy()
- Parameters:
namespaceResourcePolicy
- The resource policy that will be attached to the namespace.- Returns:
this
-
redshiftIdcApplicationArn
@Stability(Stable) public CfnNamespaceProps.Builder redshiftIdcApplicationArn(String redshiftIdcApplicationArn) Sets the value ofCfnNamespaceProps.getRedshiftIdcApplicationArn()
- Parameters:
redshiftIdcApplicationArn
- The ARN for the Redshift application that integrates with IAM Identity Center.- Returns:
this
-
snapshotCopyConfigurations
@Stability(Stable) public CfnNamespaceProps.Builder snapshotCopyConfigurations(IResolvable snapshotCopyConfigurations) Sets the value ofCfnNamespaceProps.getSnapshotCopyConfigurations()
- Parameters:
snapshotCopyConfigurations
- The snapshot copy configurations for the namespace.- Returns:
this
-
snapshotCopyConfigurations
@Stability(Stable) public CfnNamespaceProps.Builder snapshotCopyConfigurations(List<? extends Object> snapshotCopyConfigurations) Sets the value ofCfnNamespaceProps.getSnapshotCopyConfigurations()
- Parameters:
snapshotCopyConfigurations
- The snapshot copy configurations for the namespace.- Returns:
this
-
tags
Sets the value ofCfnNamespaceProps.getTags()
- Parameters:
tags
- The map of the key-value pairs used to tag the namespace.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnNamespaceProps>
- Returns:
- a new instance of
CfnNamespaceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-