Skip to content

CreateNamespaceRequest

Source code in docs_src/capo_redshift_serverless/types/create_namespace_request.py
class CreateNamespaceRequest(TypedDict, closed=True):
    namespace_name: "capo_redshift_serverless.types.namespace_name.NamespaceName"
    """<p>The name of the namespace.</p>"""
    admin_username: NotRequired["capo_redshift_serverless.types.db_user.DbUser"]
    """<p>The username of the administrator for the first database created in the namespace.</p>"""
    admin_user_password: NotRequired[
        "capo_redshift_serverless.types.db_password.DbPassword"
    ]
    """<p>The password of the administrator for the first database created in the namespace.</p> <p>You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true. </p>"""
    db_name: NotRequired["str"]
    """<p>The name of the first database created in the namespace.</p>"""
    kms_key_id: NotRequired["str"]
    """<p>The ID of the Amazon Web Services Key Management Service key used to encrypt your data.</p>"""
    default_iam_role_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.</p>"""
    iam_roles: NotRequired[
        "capo_redshift_serverless.types.iam_role_arn_list.IamRoleArnList"
    ]
    """<p>A list of IAM roles to associate with the namespace.</p>"""
    log_exports: NotRequired[
        "capo_redshift_serverless.types.log_export_list.LogExportList"
    ]
    """<p>The types of logs the namespace can export. Available export types are <code>userlog</code>, <code>connectionlog</code>, and <code>useractivitylog</code>.</p>"""
    tags: NotRequired["capo_redshift_serverless.types.tag_list.TagList"]
    """<p>A list of tag instances.</p>"""
    manage_admin_password: NotRequired["bool"]
    """<p>If <code>true</code>, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true. If <code>manageAdminPassword</code> is false or not set, Amazon Redshift uses <code>adminUserPassword</code> for the admin user account's password. </p>"""
    admin_password_secret_kms_key_id: NotRequired[
        "capo_redshift_serverless.types.kms_key_id.KmsKeyId"
    ]
    """<p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if <code>manageAdminPassword</code> is true.</p>"""
    redshift_idc_application_arn: NotRequired[
        "capo_redshift_serverless.types.redshift_idc_application_arn.RedshiftIdcApplicationArn"
    ]
    """<p>The ARN for the Redshift application that integrates with IAM Identity Center.</p>"""

admin_password_secret_kms_key_id instance-attribute

admin_password_secret_kms_key_id: NotRequired[KmsKeyId]

The ID of the 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_user_password instance-attribute

admin_user_password: NotRequired[DbPassword]

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

You can't use adminUserPassword if manageAdminPassword is true.

admin_username instance-attribute

admin_username: NotRequired[DbUser]

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

db_name instance-attribute

db_name: NotRequired[str]

The name of the first database created in the namespace.

default_iam_role_arn instance-attribute

default_iam_role_arn: NotRequired[str]

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

iam_roles instance-attribute

iam_roles: NotRequired[IamRoleArnList]

A list of IAM roles to associate with the namespace.

kms_key_id instance-attribute

kms_key_id: NotRequired[str]

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

log_exports instance-attribute

log_exports: NotRequired[LogExportList]

The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.

manage_admin_password instance-attribute

manage_admin_password: NotRequired[bool]

If true, Amazon Redshift uses 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_name instance-attribute

namespace_name: NamespaceName

The name of the namespace.

redshift_idc_application_arn instance-attribute

redshift_idc_application_arn: NotRequired[RedshiftIdcApplicationArn]

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

tags instance-attribute

tags: NotRequired[TagList]

A list of tag instances.