Update Namespace

redshiftserverless_update_namespace

R Documentation

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.

Usage

redshiftserverless_update_namespace(adminPasswordSecretKmsKeyId,
  adminUserPassword, adminUsername, defaultIamRoleArn, iamRoles, kmsKeyId,
  logExports, manageAdminPassword, namespaceName)

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.

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.

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.

Value

A list with the following syntax:

list(
  namespace = list(
    adminPasswordSecretArn = "string",
    adminPasswordSecretKmsKeyId = "string",
    adminUsername = "string",
    creationDate = as.POSIXct(
      "2015-01-01"
    ),
    dbName = "string",
    defaultIamRoleArn = "string",
    iamRoles = list(
      "string"
    ),
    kmsKeyId = "string",
    logExports = list(
      "useractivitylog"|"userlog"|"connectionlog"
    ),
    namespaceArn = "string",
    namespaceId = "string",
    namespaceName = "string",
    status = "AVAILABLE"|"MODIFYING"|"DELETING"
  )
)

Request syntax

svc$update_namespace(
  adminPasswordSecretKmsKeyId = "string",
  adminUserPassword = "string",
  adminUsername = "string",
  defaultIamRoleArn = "string",
  iamRoles = list(
    "string"
  ),
  kmsKeyId = "string",
  logExports = list(
    "useractivitylog"|"userlog"|"connectionlog"
  ),
  manageAdminPassword = TRUE|FALSE,
  namespaceName = "string"
)