Updates a namespace with the specified settings¶

Description¶

Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.

Similarly, an S3 Tables log-publishing update (a request where logDestinationType is s3table) cannot be combined with any other namespace configuration change and must be submitted as its own request.

Usage¶

redshiftserverless_update_namespace(adminPasswordSecretKmsKeyId,
  adminUserPassword, adminUsername, defaultIamRoleArn, iamRoles, kmsKeyId,
  logDestinationType, logExports, manageAdminPassword, namespaceName,
  s3TableAction, s3TableGranularity, s3TableKmsKeyId, s3TableNames)

Arguments¶

• adminPasswordSecretKmsKeyId

  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.

• adminUserPassword

  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.

• adminUsername

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

• defaultIamRoleArn

  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.

• iamRoles

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

• kmsKeyId

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

• 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.

• logExports

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

• manageAdminPassword

  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.

• namespaceName

  [required] The name of the namespace to update. You can't update the name of a namespace once it is created.

• 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.

• 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.

• s3TableKmsKeyId

  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.

• s3TableNames

  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.

Value¶

A list with the following syntax:

list(
  namespace = list(
    adminPasswordSecretArn = "string",
    adminPasswordSecretKmsKeyId = "string",
    adminUsername = "string",
    catalogArn = "string",
    creationDate = as.POSIXct(
      "2015-01-01"
    ),
    dbName = "string",
    defaultIamRoleArn = "string",
    iamRoles = list(
      "string"
    ),
    kmsKeyId = "string",
    lakehouseRegistrationStatus = "string",
    logExports = list(
      "useractivitylog"|"userlog"|"connectionlog"
    ),
    namespaceArn = "string",
    namespaceId = "string",
    namespaceName = "string",
    s3TablePublishStatus = list(
      enabledAll = TRUE|FALSE,
      lastIngestionTimes = list(
        "string"
      ),
      s3TableGranularity = "namespace"|"account",
      s3TableNamespace = "string",
      s3Tables = list(
        "string"
      )
    ),
    status = "AVAILABLE"|"MODIFYING"|"DELETING"
  )
)

Request syntax¶

svc$update_namespace(
  adminPasswordSecretKmsKeyId = "string",
  adminUserPassword = "string",
  adminUsername = "string",
  defaultIamRoleArn = "string",
  iamRoles = list(
    "string"
  ),
  kmsKeyId = "string",
  logDestinationType = "s3table"|"cloudwatch",
  logExports = list(
    "useractivitylog"|"userlog"|"connectionlog"
  ),
  manageAdminPassword = TRUE|FALSE,
  namespaceName = "string",
  s3TableAction = "Enable"|"Disable",
  s3TableGranularity = "namespace"|"account",
  s3TableKmsKeyId = "string",
  s3TableNames = list(
    "string"
  )
)