[ aws . redshift-serverless ]

update-namespace

Description

Updates a namespace with the specified settings.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-namespace
[--admin-user-password <value>]
[--admin-username <value>]
[--default-iam-role-arn <value>]
[--iam-roles <value>]
[--kms-key-id <value>]
[--log-exports <value>]
--namespace-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--admin-user-password (string)

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

--admin-username (string)

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

--default-iam-role-arn (string)

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

--iam-roles (list)

A list of IAM roles to associate with the namespace.

(string)

Syntax:

"string" "string" ...

--kms-key-id (string)

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

--log-exports (list)

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

(string)

Syntax:

"string" "string" ...

Where valid values are:
  useractivitylog
  userlog
  connectionlog

--namespace-name (string)

The name of the namespace.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

namespace -> (structure)

A list of tag instances.

adminUsername -> (string)

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

creationDate -> (timestamp)

The date of when the namespace was created.

dbName -> (string)

The name of the first database created in the namespace.

defaultIamRoleArn -> (string)

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

iamRoles -> (list)

A list of IAM roles to associate with the namespace.

(string)

kmsKeyId -> (string)

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

logExports -> (list)

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

(string)

namespaceArn -> (string)

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

namespaceId -> (string)

The unique identifier of a namespace.

namespaceName -> (string)

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.

status -> (string)

The status of the namespace.