Skip to content

Create Namespace

redshiftserverless_create_namespace R Documentation

Creates a namespace in Amazon Redshift Serverless

Description

Creates a namespace in Amazon Redshift Serverless.

Usage

redshiftserverless_create_namespace(adminPasswordSecretKmsKeyId,
  adminUserPassword, adminUsername, dbName, defaultIamRoleArn, iamRoles,
  kmsKeyId, logExports, manageAdminPassword, namespaceName,
  redshiftIdcApplicationArn, tags)

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.

You can't use adminUserPassword if manageAdminPassword is true.

adminUsername

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

dbName

The name of the first database created in the namespace.

defaultIamRoleArn

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

iamRoles

A list of IAM roles to associate with the namespace.

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

redshiftIdcApplicationArn

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

tags

A list of tag instances.

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$create_namespace(
  adminPasswordSecretKmsKeyId = "string",
  adminUserPassword = "string",
  adminUsername = "string",
  dbName = "string",
  defaultIamRoleArn = "string",
  iamRoles = list(
    "string"
  ),
  kmsKeyId = "string",
  logExports = list(
    "useractivitylog"|"userlog"|"connectionlog"
  ),
  manageAdminPassword = TRUE|FALSE,
  namespaceName = "string",
  redshiftIdcApplicationArn = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)