import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { CreateDiskSnapshotRequest, CreateDiskSnapshotResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateDiskSnapshotCommand}. */ export interface CreateDiskSnapshotCommandInput extends CreateDiskSnapshotRequest { } /** * @public * * The output of {@link CreateDiskSnapshotCommand}. */ export interface CreateDiskSnapshotCommandOutput extends CreateDiskSnapshotResult, __MetadataBearer { } declare const CreateDiskSnapshotCommand_base: { new (input: CreateDiskSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateDiskSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make * copies of disks, and to save data before shutting down a Lightsail instance.

*

You can take a snapshot of an attached disk that is in use; however, snapshots only * capture data that has been written to your disk at the time the snapshot command is issued. * This may exclude any data that has been cached by any applications or the operating system. If * you can pause any file systems on the disk long enough to take a snapshot, your snapshot * should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should * unmount the disk from within the Lightsail instance, issue the create disk snapshot command, * and then remount the disk to ensure a consistent and complete snapshot. You may remount and * use your disk while the snapshot status is pending.

*

You can also use this operation to create a snapshot of an instance's system volume. You * might want to do this, for example, to recover data from the system volume of a botched * instance or to create a backup of the system volume like you would for a block storage disk. * To create a snapshot of a system volume, just define the instance name parameter * when issuing the snapshot command, and a snapshot of the defined instance's system volume will * be created. After the snapshot is available, you can create a block storage disk from the * snapshot and attach it to a running instance to access the data on the disk.

*

The create disk snapshot operation supports tag-based access control via * request tags. For more information, see the Amazon Lightsail Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, CreateDiskSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, CreateDiskSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // CreateDiskSnapshotRequest * diskName: "STRING_VALUE", * diskSnapshotName: "STRING_VALUE", // required * instanceName: "STRING_VALUE", * tags: [ // TagList * { // Tag * key: "STRING_VALUE", * value: "STRING_VALUE", * }, * ], * }; * const command = new CreateDiskSnapshotCommand(input); * const response = await client.send(command); * // { // CreateDiskSnapshotResult * // operations: [ // OperationList * // { // Operation * // id: "STRING_VALUE", * // resourceName: "STRING_VALUE", * // resourceType: "ContainerService" || "Instance" || "StaticIp" || "KeyPair" || "InstanceSnapshot" || "Domain" || "PeeredVpc" || "LoadBalancer" || "LoadBalancerTlsCertificate" || "Disk" || "DiskSnapshot" || "RelationalDatabase" || "RelationalDatabaseSnapshot" || "ExportSnapshotRecord" || "CloudFormationStackRecord" || "Alarm" || "ContactMethod" || "Distribution" || "Certificate" || "Bucket", * // createdAt: new Date("TIMESTAMP"), * // location: { // ResourceLocation * // availabilityZone: "STRING_VALUE", * // regionName: "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-central-1" || "eu-north-1" || "ca-central-1" || "ap-south-1" || "ap-southeast-1" || "ap-southeast-2" || "ap-northeast-1" || "ap-northeast-2" || "ap-southeast-3" || "ap-southeast-5", * // }, * // isTerminal: true || false, * // operationDetails: "STRING_VALUE", * // operationType: "DeleteKnownHostKeys" || "DeleteInstance" || "CreateInstance" || "StopInstance" || "StartInstance" || "RebootInstance" || "OpenInstancePublicPorts" || "PutInstancePublicPorts" || "CloseInstancePublicPorts" || "AllocateStaticIp" || "ReleaseStaticIp" || "AttachStaticIp" || "DetachStaticIp" || "UpdateDomainEntry" || "DeleteDomainEntry" || "CreateDomain" || "DeleteDomain" || "CreateInstanceSnapshot" || "DeleteInstanceSnapshot" || "CreateInstancesFromSnapshot" || "CreateLoadBalancer" || "DeleteLoadBalancer" || "AttachInstancesToLoadBalancer" || "DetachInstancesFromLoadBalancer" || "UpdateLoadBalancerAttribute" || "CreateLoadBalancerTlsCertificate" || "DeleteLoadBalancerTlsCertificate" || "AttachLoadBalancerTlsCertificate" || "CreateDisk" || "DeleteDisk" || "AttachDisk" || "DetachDisk" || "CreateDiskSnapshot" || "DeleteDiskSnapshot" || "CreateDiskFromSnapshot" || "CreateRelationalDatabase" || "UpdateRelationalDatabase" || "DeleteRelationalDatabase" || "CreateRelationalDatabaseFromSnapshot" || "CreateRelationalDatabaseSnapshot" || "DeleteRelationalDatabaseSnapshot" || "UpdateRelationalDatabaseParameters" || "StartRelationalDatabase" || "RebootRelationalDatabase" || "StopRelationalDatabase" || "EnableAddOn" || "DisableAddOn" || "PutAlarm" || "GetAlarms" || "DeleteAlarm" || "TestAlarm" || "CreateContactMethod" || "GetContactMethods" || "SendContactMethodVerification" || "DeleteContactMethod" || "CreateDistribution" || "UpdateDistribution" || "DeleteDistribution" || "ResetDistributionCache" || "AttachCertificateToDistribution" || "DetachCertificateFromDistribution" || "UpdateDistributionBundle" || "SetIpAddressType" || "CreateCertificate" || "DeleteCertificate" || "CreateContainerService" || "UpdateContainerService" || "DeleteContainerService" || "CreateContainerServiceDeployment" || "CreateContainerServiceRegistryLogin" || "RegisterContainerImage" || "DeleteContainerImage" || "CreateBucket" || "DeleteBucket" || "CreateBucketAccessKey" || "DeleteBucketAccessKey" || "UpdateBucketBundle" || "UpdateBucket" || "SetResourceAccessForBucket" || "UpdateInstanceMetadataOptions" || "StartGUISession" || "StopGUISession" || "SetupInstanceHttps", * // status: "NotStarted" || "Started" || "Failed" || "Completed" || "Succeeded", * // statusChangedAt: new Date("TIMESTAMP"), * // errorCode: "STRING_VALUE", * // errorDetails: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param CreateDiskSnapshotCommandInput - {@link CreateDiskSnapshotCommandInput} * @returns {@link CreateDiskSnapshotCommandOutput} * @see {@link CreateDiskSnapshotCommandInput} for command's `input` shape. * @see {@link CreateDiskSnapshotCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Lightsail throws this exception when the user cannot be authenticated or uses invalid * credentials to access a resource.

* * @throws {@link AccountSetupInProgressException} (client fault) *

Lightsail throws this exception when an account is still in the setup in progress * state.

* * @throws {@link InvalidInputException} (client fault) *

Lightsail throws this exception when user input does not conform to the validation rules * of an input field.

* *

Domain and distribution APIs are only available in the N. Virginia * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

*
* * @throws {@link NotFoundException} (client fault) *

Lightsail throws this exception when it cannot find a resource.

* * @throws {@link OperationFailureException} (client fault) *

Lightsail throws this exception when an operation fails to execute.

* * @throws {@link RegionSetupInProgressException} (client fault) *

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

* * @throws {@link ServiceException} (server fault) *

A general service exception.

* * @throws {@link UnauthenticatedException} (client fault) *

Lightsail throws this exception when the user has not been authenticated.

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class CreateDiskSnapshotCommand extends CreateDiskSnapshotCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateDiskSnapshotRequest; output: CreateDiskSnapshotResult; }; sdk: { input: CreateDiskSnapshotCommandInput; output: CreateDiskSnapshotCommandOutput; }; }; }