CfnNamespaceProps

class aws_cdk.aws_redshiftserverless.CfnNamespaceProps(*, namespace_name, admin_password_secret_kms_key_id=None, admin_username=None, admin_user_password=None, db_name=None, default_iam_role_arn=None, final_snapshot_name=None, final_snapshot_retention_period=None, iam_roles=None, kms_key_id=None, log_exports=None, manage_admin_password=None, namespace_resource_policy=None, redshift_idc_application_arn=None, snapshot_copy_configurations=None, tags=None)

Bases: object

Properties for defining a CfnNamespace.

Parameters:

namespace_name (str) – 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.
admin_password_secret_kms_key_id (Optional[str]) – 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 .
admin_username (Optional[str]) – The username of the administrator for the primary database created in the namespace.
admin_user_password (Optional[str]) – The password of the administrator for the primary database created in the namespace.
db_name (Optional[str]) – The name of the primary database created in the namespace.
default_iam_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
final_snapshot_name (Optional[str]) – The name of the snapshot to be created before the namespace is deleted.
final_snapshot_retention_period (Union[int, float, None]) – How long to retain the final snapshot.
iam_roles (Optional[Sequence[str]]) – A list of IAM roles to associate with the namespace.
kms_key_id (Optional[str]) – The ID of the AWS Key Management Service key used to encrypt your data.
log_exports (Optional[Sequence[str]]) – The types of logs the namespace can export. Available export types are userlog , connectionlog , and useractivitylog .
manage_admin_password (Union[bool, IResolvable, None]) – 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.
namespace_resource_policy (Any) – The resource policy that will be attached to the namespace.
redshift_idc_application_arn (Optional[str]) – The ARN for the Redshift application that integrates with IAM Identity Center.
snapshot_copy_configurations (Union[IResolvable, Sequence[Union[IResolvable, SnapshotCopyConfigurationProperty, Dict[str, Any]]], None]) – The snapshot copy configurations for the namespace.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The map of the key-value pairs used to tag the namespace.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_redshiftserverless as redshiftserverless

# namespace_resource_policy: Any

cfn_namespace_props = redshiftserverless.CfnNamespaceProps(
    namespace_name="namespaceName",

    # the properties below are optional
    admin_password_secret_kms_key_id="adminPasswordSecretKmsKeyId",
    admin_username="adminUsername",
    admin_user_password="adminUserPassword",
    db_name="dbName",
    default_iam_role_arn="defaultIamRoleArn",
    final_snapshot_name="finalSnapshotName",
    final_snapshot_retention_period=123,
    iam_roles=["iamRoles"],
    kms_key_id="kmsKeyId",
    log_exports=["logExports"],
    manage_admin_password=False,
    namespace_resource_policy=namespace_resource_policy,
    redshift_idc_application_arn="redshiftIdcApplicationArn",
    snapshot_copy_configurations=[redshiftserverless.CfnNamespace.SnapshotCopyConfigurationProperty(
        destination_region="destinationRegion",

        # the properties below are optional
        destination_kms_key_id="destinationKmsKeyId",
        snapshot_retention_period=123
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

admin_password_secret_kms_key_id

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

admin_user_password

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

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

admin_username

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

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

db_name

The name of the primary database created in the namespace.

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

default_iam_role_arn

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

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

final_snapshot_name

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

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

final_snapshot_retention_period

How long to retain the final snapshot.

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

iam_roles

A list of IAM roles to associate with the namespace.

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

kms_key_id

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

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

log_exports

The types of logs the namespace can export.

Available export types are userlog , connectionlog , and useractivitylog .

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

manage_admin_password

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

namespace_name

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

namespace_resource_policy

The resource policy that will be attached to the namespace.

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

redshift_idc_application_arn

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

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

snapshot_copy_configurations

The snapshot copy configurations for the namespace.

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

tags

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

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