Package software.amazon.awscdk.cfnpropertymixins.services.redshiftserverless

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 Type	Method	Description
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.
CfnNamespacePropsMixin.Builder	adminUsername(String adminUsername)	The username of the administrator for the primary database created in the namespace.
CfnNamespacePropsMixin.Builder	adminUserPassword(String adminUserPassword)	The password of the administrator for the primary database created in the namespace.
CfnNamespacePropsMixin	build()
static CfnNamespacePropsMixin.Builder	create()
static CfnNamespacePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnNamespacePropsMixin.Builder	dbName(String dbName)	The name of the primary database created in the namespace.
CfnNamespacePropsMixin.Builder	defaultIamRoleArn(String defaultIamRoleArn)	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
CfnNamespacePropsMixin.Builder	defaultIamRoleArn(IRoleRef defaultIamRoleArn)	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
CfnNamespacePropsMixin.Builder	finalSnapshotName(String finalSnapshotName)	The name of the snapshot to be created before the namespace is deleted.
CfnNamespacePropsMixin.Builder	finalSnapshotRetentionPeriod(Number finalSnapshotRetentionPeriod)	How long to retain the final snapshot.
CfnNamespacePropsMixin.Builder	iamRoles(List<? extends Object> iamRoles)	A list of IAM roles to associate with the namespace.
CfnNamespacePropsMixin.Builder	kmsKeyId(String kmsKeyId)	The ID of the AWS Key Management Service key used to encrypt your data.
CfnNamespacePropsMixin.Builder	kmsKeyId(IKeyRef kmsKeyId)	The ID of the AWS Key Management Service key used to encrypt your data.
CfnNamespacePropsMixin.Builder	logExports(List<String> logExports)	The types of logs the namespace can export.
CfnNamespacePropsMixin.Builder	manageAdminPassword(Boolean manageAdminPassword)	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
CfnNamespacePropsMixin.Builder	manageAdminPassword(IResolvable manageAdminPassword)	If true, Amazon Redshift uses AWS Secrets Manager to manage the namespace's admin credentials.
CfnNamespacePropsMixin.Builder	namespaceName(String namespaceName)	The name of the namespace.
CfnNamespacePropsMixin.Builder	namespaceResourcePolicy(Object namespaceResourcePolicy)	The resource policy that will be attached to the namespace.
CfnNamespacePropsMixin.Builder	redshiftIdcApplicationArn(String redshiftIdcApplicationArn)	The ARN for the Redshift application that integrates with IAM Identity Center.
CfnNamespacePropsMixin.Builder	snapshotCopyConfigurations(List<? extends Object> snapshotCopyConfigurations)	The snapshot copy configurations for the namespace.
CfnNamespacePropsMixin.Builder	snapshotCopyConfigurations(IResolvable snapshotCopyConfigurations)	The snapshot copy configurations for the namespace.
CfnNamespacePropsMixin.Builder	tags(List<? extends CfnTag> tags)	The map of the key-value pairs used to tag the namespace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnNamespacePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnNamespacePropsMixin.Builder.

create

@Stability(Stable)
public static 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 ManageAdminPassword is true .

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:

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

adminUsername

@Stability(Stable)
public CfnNamespacePropsMixin.Builder adminUsername(String 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:

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

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:

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

dbName

@Stability(Stable)
public CfnNamespacePropsMixin.Builder dbName(String 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:

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

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:

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

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:

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

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:

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

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:

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

iamRoles

@Stability(Stable)
public CfnNamespacePropsMixin.Builder iamRoles(List<? extends Object> 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:

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

kmsKeyId

@Stability(Stable)
public CfnNamespacePropsMixin.Builder kmsKeyId(String 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:

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

kmsKeyId

@Stability(Stable)
public CfnNamespacePropsMixin.Builder kmsKeyId(IKeyRef 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:

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

logExports

@Stability(Stable)
public CfnNamespacePropsMixin.Builder logExports(List<String> logExports)

The types of logs the namespace can export.

Available export types are userlog , connectionlog , and useractivitylog .

Parameters:

logExports - The types of logs the namespace can export. This parameter is required.

Returns:

this

See Also:

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

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 AdminUserPassword if ManageAdminPassword is true. If ManageAdminPassword is false or not set, Amazon Redshift uses AdminUserPassword for 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:

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

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 AdminUserPassword if ManageAdminPassword is true. If ManageAdminPassword is false or not set, Amazon Redshift uses AdminUserPassword for 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:

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

namespaceName

@Stability(Stable)
public CfnNamespacePropsMixin.Builder namespaceName(String 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:

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

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:

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

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:

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

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:

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

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:

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

tags

@Stability(Stable)
public CfnNamespacePropsMixin.Builder tags(List<? extends CfnTag> 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:

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

build

@Stability(Stable)
public CfnNamespacePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnNamespacePropsMixin>

Returns:

a newly built instance of CfnNamespacePropsMixin.