Skip to content

Namespace

Source code in docs_src/capo_redshift_serverless/types/namespace.py
class Namespace(TypedDict, closed=True):
    namespace_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) associated with a namespace.</p>"""
    namespace_id: NotRequired["str"]
    """<p>The unique identifier of a namespace.</p>"""
    namespace_name: NotRequired[
        "capo_redshift_serverless.types.namespace_name.NamespaceName"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</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>"""
    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 User log, Connection log, and User activity log.</p>"""
    status: NotRequired[
        "capo_redshift_serverless.types.namespace_status.NamespaceStatus"
    ]
    """<p>The status of the namespace.</p>"""
    creation_date: NotRequired["datetime.datetime"]
    """<p>The date of when the namespace was created.</p>"""
    admin_password_secret_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.</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.</p>"""
    lakehouse_registration_status: NotRequired["str"]
    """<p>The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.</p>"""
    catalog_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.</p>"""
    s3_table_publish_status: NotRequired[
        "capo_redshift_serverless.types.s3_table_publish_status.S3TablePublishStatus"
    ]
    """<p>The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace.</p>"""

admin_password_secret_arn instance-attribute

admin_password_secret_arn: NotRequired[str]

The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

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.

admin_username instance-attribute

admin_username: NotRequired[DbUser]

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

catalog_arn instance-attribute

catalog_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the namespace enabled with Amazon Redshift federated permissions.

creation_date instance-attribute

creation_date: NotRequired[datetime]

The date of when the namespace was created.

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.

lakehouse_registration_status instance-attribute

lakehouse_registration_status: NotRequired[str]

The status of the lakehouse registration for the namespace. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.

log_exports instance-attribute

log_exports: NotRequired[LogExportList]

The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

namespace_arn instance-attribute

namespace_arn: NotRequired[str]

The Amazon Resource Name (ARN) associated with a namespace.

namespace_id instance-attribute

namespace_id: NotRequired[str]

The unique identifier of a namespace.

namespace_name instance-attribute

namespace_name: NotRequired[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.

s3_table_publish_status instance-attribute

s3_table_publish_status: NotRequired[S3TablePublishStatus]

The current Amazon S3 Tables log-publishing status for the namespace. Not returned when S3 Tables publishing has never been configured for the namespace.

status instance-attribute

status: NotRequired[NamespaceStatus]

The status of the namespace.