import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import type { CreateSnapshotRequest, Snapshot } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateSnapshotCommand}. */ export interface CreateSnapshotCommandInput extends CreateSnapshotRequest { } /** * @public * * The output of {@link CreateSnapshotCommand}. */ export interface CreateSnapshotCommandOutput extends Snapshot, __MetadataBearer { } declare const CreateSnapshotCommand_base: { new (input: CreateSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for * backups, to make copies of EBS volumes, and to save data before shutting down an * instance.

*

The location of the source EBS volume determines where you can create the snapshot.

* *

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the * source volume are propagated to the snapshot.

*

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

*

When you create a snapshot for an EBS volume that serves as a root device, we recommend * that you stop the instance before taking the snapshot.

*

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that * are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes * and any associated snapshots always remain protected. For more information, see Amazon EBS encryption * in the Amazon EBS User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { EC2Client, CreateSnapshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import * // const { EC2Client, CreateSnapshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import * // import type { EC2ClientConfig } from "@aws-sdk/client-ec2"; * const config = {}; // type is EC2ClientConfig * const client = new EC2Client(config); * const input = { // CreateSnapshotRequest * Description: "STRING_VALUE", * OutpostArn: "STRING_VALUE", * VolumeId: "STRING_VALUE", // required * TagSpecifications: [ // TagSpecificationList * { // TagSpecification * ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "image-usage-report" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "outpost-lag" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "service-link-virtual-interface" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-metering-policy" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "vpc-encryption-control" || "route-server" || "route-server-endpoint" || "route-server-peer" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token" || "capacity-block" || "mac-modification-task" || "ipam-prefix-list-resolver" || "ipam-policy" || "ipam-prefix-list-resolver-target" || "secondary-interface" || "secondary-network" || "secondary-subnet" || "capacity-manager-data-export" || "vpn-concentrator", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }, * ], * Location: "regional" || "local", * DryRun: true || false, * }; * const command = new CreateSnapshotCommand(input); * const response = await client.send(command); * // { // Snapshot * // OwnerAlias: "STRING_VALUE", * // OutpostArn: "STRING_VALUE", * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // StorageTier: "archive" || "standard", * // RestoreExpiryTime: new Date("TIMESTAMP"), * // SseType: "sse-ebs" || "sse-kms" || "none", * // AvailabilityZone: "STRING_VALUE", * // TransferType: "time-based" || "standard", * // CompletionDurationMinutes: Number("int"), * // CompletionTime: new Date("TIMESTAMP"), * // FullSnapshotSizeInBytes: Number("long"), * // SnapshotId: "STRING_VALUE", * // VolumeId: "STRING_VALUE", * // State: "pending" || "completed" || "error" || "recoverable" || "recovering", * // StateMessage: "STRING_VALUE", * // StartTime: new Date("TIMESTAMP"), * // Progress: "STRING_VALUE", * // OwnerId: "STRING_VALUE", * // Description: "STRING_VALUE", * // VolumeSize: Number("int"), * // Encrypted: true || false, * // KmsKeyId: "STRING_VALUE", * // DataEncryptionKeyId: "STRING_VALUE", * // }; * * ``` * * @param CreateSnapshotCommandInput - {@link CreateSnapshotCommandInput} * @returns {@link CreateSnapshotCommandOutput} * @see {@link CreateSnapshotCommandInput} for command's `input` shape. * @see {@link CreateSnapshotCommandOutput} for command's `response` shape. * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. * * @throws {@link EC2ServiceException} *

Base exception class for all service exceptions from EC2 service.

* * * @example To create a snapshot * ```javascript * // This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot. * const input = { * Description: "This is my root volume snapshot.", * VolumeId: "vol-1234567890abcdef0" * }; * const command = new CreateSnapshotCommand(input); * const response = await client.send(command); * /* response is * { * Description: "This is my root volume snapshot.", * OwnerId: "012345678910", * SnapshotId: "snap-066877671789bd71b", * StartTime: "2014-02-28T21:06:01.000Z", * State: "pending", * Tags: [], * VolumeId: "vol-1234567890abcdef0", * VolumeSize: 8 * } * *\/ * ``` * * @public */ export declare class CreateSnapshotCommand extends CreateSnapshotCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateSnapshotRequest; output: Snapshot; }; sdk: { input: CreateSnapshotCommandInput; output: CreateSnapshotCommandOutput; }; }; }