[ aws . redshift-serverless ]

create-snapshot

Description

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-snapshot
--namespace-name <value>
[--retention-period <value>]
--snapshot-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--namespace-name (string)

The namespace to create a snapshot for.

--retention-period (integer)

How long to retain the created snapshot.

--snapshot-name (string)

The name of 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.

See ‘aws help’ for descriptions of global parameters.

Output

snapshot -> (structure)

The created snapshot object.

accountsWithProvisionedRestoreAccess -> (list)

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

(string)

accountsWithRestoreAccess -> (list)

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

(string)

actualIncrementalBackupSizeInMegaBytes -> (double)

The size of the incremental backup in megabytes.

adminUsername -> (string)

The username of the database within a snapshot.

backupProgressInMegaBytes -> (double)

The size in megabytes of the data that has been backed up to a snapshot.

currentBackupRateInMegaBytesPerSecond -> (double)

The rate at which data is backed up into a snapshot in megabytes per second.

elapsedTimeInSeconds -> (long)

The amount of time it took to back up data into a snapshot.

estimatedSecondsToCompletion -> (long)

The estimated amount of seconds until the snapshot completes backup.

kmsKeyId -> (string)

The unique identifier of the KMS key used to encrypt the snapshot.

namespaceArn -> (string)

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

namespaceName -> (string)

The name of the namepsace.

ownerAccount -> (string)

The owner Amazon Web Services; account of the snapshot.

snapshotArn -> (string)

The Amazon Resource Name (ARN) of the snapshot.

snapshotCreateTime -> (timestamp)

The timestamp of when the snapshot was created.

snapshotName -> (string)

The name of the snapshot.

snapshotRemainingDays -> (integer)

The amount of days until the snapshot is deleted.

snapshotRetentionPeriod -> (integer)

The period of time, in days, of how long the snapshot is retained.

snapshotRetentionStartTime -> (timestamp)

The timestamp of when data within the snapshot started getting retained.

status -> (string)

The status of the snapshot.

totalBackupSizeInMegaBytes -> (double)

The total size, in megabytes, of how big the snapshot is.