ModifyClusterSnapshotCommand

Suggest an Edit

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, ModifyClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, ModifyClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // ModifyClusterSnapshotMessage
  SnapshotIdentifier: "STRING_VALUE", // required
  ManualSnapshotRetentionPeriod: Number("int"),
  Force: true || false,
};
const command = new ModifyClusterSnapshotCommand(input);
const response = await client.send(command);
// { // ModifyClusterSnapshotResult
//   Snapshot: { // Snapshot
//     SnapshotIdentifier: "STRING_VALUE",
//     ClusterIdentifier: "STRING_VALUE",
//     SnapshotCreateTime: new Date("TIMESTAMP"),
//     Status: "STRING_VALUE",
//     Port: Number("int"),
//     AvailabilityZone: "STRING_VALUE",
//     ClusterCreateTime: new Date("TIMESTAMP"),
//     MasterUsername: "STRING_VALUE",
//     ClusterVersion: "STRING_VALUE",
//     EngineFullVersion: "STRING_VALUE",
//     SnapshotType: "STRING_VALUE",
//     NodeType: "STRING_VALUE",
//     NumberOfNodes: Number("int"),
//     DBName: "STRING_VALUE",
//     VpcId: "STRING_VALUE",
//     Encrypted: true || false,
//     KmsKeyId: "STRING_VALUE",
//     EncryptedWithHSM: true || false,
//     AccountsWithRestoreAccess: [ // AccountsWithRestoreAccessList
//       { // AccountWithRestoreAccess
//         AccountId: "STRING_VALUE",
//         AccountAlias: "STRING_VALUE",
//       },
//     ],
//     OwnerAccount: "STRING_VALUE",
//     TotalBackupSizeInMegaBytes: Number("double"),
//     ActualIncrementalBackupSizeInMegaBytes: Number("double"),
//     BackupProgressInMegaBytes: Number("double"),
//     CurrentBackupRateInMegaBytesPerSecond: Number("double"),
//     EstimatedSecondsToCompletion: Number("long"),
//     ElapsedTimeInSeconds: Number("long"),
//     SourceRegion: "STRING_VALUE",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     RestorableNodeTypes: [ // RestorableNodeTypeList
//       "STRING_VALUE",
//     ],
//     EnhancedVpcRouting: true || false,
//     MaintenanceTrackName: "STRING_VALUE",
//     ManualSnapshotRetentionPeriod: Number("int"),
//     ManualSnapshotRemainingDays: Number("int"),
//     SnapshotRetentionStartTime: new Date("TIMESTAMP"),
//     MasterPasswordSecretArn: "STRING_VALUE",
//     MasterPasswordSecretKmsKeyId: "STRING_VALUE",
//     SnapshotArn: "STRING_VALUE",
//   },
// };

ModifyClusterSnapshotCommand Input

See ModifyClusterSnapshotCommandInput for more details

Parameter
Type
Description
SnapshotIdentifier
Required
string | undefined

The identifier of the snapshot whose setting you want to modify.

Force
boolean | undefined

A Boolean option to override an exception if the retention period has already passed.

ManualSnapshotRetentionPeriod
number | undefined

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

The value must be either -1 or an integer between 1 and 3,653.

ModifyClusterSnapshotCommand Output

See ModifyClusterSnapshotCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Snapshot
Snapshot | undefined

Describes a snapshot.

Throws

Name
Fault
Details
ClusterSnapshotNotFoundFault
client

The snapshot identifier does not refer to an existing cluster snapshot.

InvalidClusterSnapshotStateFault
client

The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.

InvalidRetentionPeriodFault
client

The retention period specified is either in the past or is not a valid value.

The value must be either -1 or an integer between 1 and 3,653.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.