[ aws . redshift-serverless ]

restore-from-snapshot

Description

Restores a namespace from a snapshot.

See also: AWS API Documentation

Synopsis

  restore-from-snapshot
[--admin-password-secret-kms-key-id <value>]
[--manage-admin-password | --no-manage-admin-password]
--namespace-name <value>
[--owner-account <value>]
[--snapshot-arn <value>]
[--snapshot-name <value>]
--workgroup-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--admin-password-secret-kms-key-id (string)

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

--manage-admin-password | --no-manage-admin-password (boolean)

If true , Amazon Redshift uses Secrets Manager to manage the restored snapshot’s admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

--namespace-name (string)

The name of the namespace to restore the snapshot to.

--owner-account (string)

The Amazon Web Services account that owns the snapshot.

--snapshot-arn (string)

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName .

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

--snapshot-name (string)

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn .

--workgroup-name (string)

The name of the workgroup used to restore the snapshot.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

namespace -> (structure)

A collection of database objects and users.

adminPasswordSecretArn -> (string)

The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.

adminPasswordSecretKmsKeyId -> (string)

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

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.

ownerAccount -> (string)

The owner Amazon Web Services; account of the snapshot that was restored.

snapshotName -> (string)

The name of the snapshot used to restore the namespace.