Skip to content

UpdateNamespaceRequest

Source code in docs_src/capo_redshift_serverless/types/update_namespace_request.py
class UpdateNamespaceRequest(TypedDict, closed=True):
    namespace_name: "capo_redshift_serverless.types.namespace_name.NamespaceName"
    """<p>The name of the namespace to update. You can't update the name of a namespace once it is created.</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. This parameter must be updated together with <code>adminUsername</code>.</p> <p>You can't use <code>adminUserPassword</code> if <code>manageAdminPassword</code> is true. </p> <p>If your admin user account is locked, this operation also unlocks your account and resets the failed-login counter. This option is available only when account lockout security is enabled for 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. This parameter must be updated together with <code>adminUserPassword</code>.</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. This parameter must be updated together with <code>iamRoles</code>.</p>"""
    iam_roles: NotRequired[
        "capo_redshift_serverless.types.iam_role_arn_list.IamRoleArnList"
    ]
    """<p>A list of IAM roles to associate with the namespace. This parameter must be updated together with <code>defaultIamRoleArn</code>.</p>"""
    log_exports: NotRequired[
        "capo_redshift_serverless.types.log_export_list.LogExportList"
    ]
    """<p>The types of logs the namespace can export. The export types are <code>userlog</code>, <code>connectionlog</code>, and <code>useractivitylog</code>.</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>"""
    log_destination_type: NotRequired[
        "capo_redshift_serverless.types.log_destination_type.LogDestinationType"
    ]
    """<p>The destination for the log data. Valid values are <code>s3table</code> and <code>cloudwatch</code>.</p> <p>Set this to <code>s3table</code> to manage Amazon S3 Tables system-table publishing for the namespace.</p>"""
    s3_table_action: NotRequired[
        "capo_redshift_serverless.types.s3_table_action.S3TableAction"
    ]
    """<p>Whether to enable or disable Amazon S3 Tables publishing. Valid values are <code>Enable</code> and <code>Disable</code>, matched case-insensitively.</p> <p>When omitted, defaults to <code>Enable</code>. Valid only when <code>logDestinationType</code> is <code>s3table</code>.</p>"""
    s3_table_names: NotRequired[
        "capo_redshift_serverless.types.s3_table_name_list.S3TableNameList"
    ]
    """<p>The system tables to publish (on enable) or to stop publishing (on disable). Each value is either a system table view name that begins with <code>sys_</code> or the keyword <code>all</code>.</p> <p>Omitting this parameter, passing an empty list, or including <code>all</code> each select every current and future system table. Each name must be 1-128 characters, and the list can contain up to 256 names.</p> <p>Valid only when <code>logDestinationType</code> is <code>s3table</code>.</p>"""
    s3_table_kms_key_id: NotRequired[
        "capo_redshift_serverless.types.kms_key_id.KmsKeyId"
    ]
    """<p>The identifier of the Key Management Service key used to encrypt the published Amazon S3 Tables data. When omitted, the data is encrypted with SSE-S3 (Amazon S3 managed keys).</p> <p>Valid only when <code>logDestinationType</code> is <code>s3table</code>.</p>"""
    s3_table_granularity: NotRequired[
        "capo_redshift_serverless.types.s3_table_granularity.S3TableGranularity"
    ]
    """<p>The scope of the Amazon S3 Tables destination. Valid values are <code>namespace</code> and <code>account</code>, matched case-insensitively. <code>namespace</code> scopes the published tables to this namespace; <code>account</code> scopes them to the Amazon Web Services account.</p> <p>Required when enabling. Omitting this parameter or passing a blank value fails with <code>ValidationException</code>. Valid only when <code>logDestinationType</code> is <code>s3table</code>.</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. This parameter must be updated together with adminUsername.

You can't use adminUserPassword if manageAdminPassword is true.

If your admin user account is locked, this operation also unlocks your account and resets the failed-login counter. This option is available only when account lockout security is enabled for the namespace.

admin_username instance-attribute

admin_username: NotRequired[DbUser]

The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

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. This parameter must be updated together with iamRoles.

iam_roles instance-attribute

iam_roles: NotRequired[IamRoleArnList]

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

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_destination_type instance-attribute

log_destination_type: NotRequired[LogDestinationType]

The destination for the log data. Valid values are s3table and cloudwatch.

Set this to s3table to manage Amazon S3 Tables system-table publishing for the namespace.

log_exports instance-attribute

log_exports: NotRequired[LogExportList]

The types of logs the namespace can export. The 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 to update. You can't update the name of a namespace once it is created.

s3_table_action instance-attribute

s3_table_action: NotRequired[S3TableAction]

Whether to enable or disable Amazon S3 Tables publishing. Valid values are Enable and Disable, matched case-insensitively.

When omitted, defaults to Enable. Valid only when logDestinationType is s3table.

s3_table_granularity instance-attribute

s3_table_granularity: NotRequired[S3TableGranularity]

The scope of the Amazon S3 Tables destination. Valid values are namespace and account, matched case-insensitively. namespace scopes the published tables to this namespace; account scopes them to the Amazon Web Services account.

Required when enabling. Omitting this parameter or passing a blank value fails with ValidationException. Valid only when logDestinationType is s3table.

s3_table_kms_key_id instance-attribute

s3_table_kms_key_id: NotRequired[KmsKeyId]

The identifier of the Key Management Service key used to encrypt the published Amazon S3 Tables data. When omitted, the data is encrypted with SSE-S3 (Amazon S3 managed keys).

Valid only when logDestinationType is s3table.

s3_table_names instance-attribute

s3_table_names: NotRequired[S3TableNameList]

The system tables to publish (on enable) or to stop publishing (on disable). Each value is either a system table view name that begins with sys_ or the keyword all.

Omitting this parameter, passing an empty list, or including all each select every current and future system table. Each name must be 1-128 characters, and the list can contain up to 256 names.

Valid only when logDestinationType is s3table.