Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EBS

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the Amazon Web Services General Reference.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of EBSClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

completeSnapshot

  • Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

    Parameters

    Returns Promise<CompleteSnapshotCommandOutput>

  • Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

    Parameters

    Returns void

  • Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

    Parameters

    Returns void

  • Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

    Parameters

    • args: CompleteSnapshotCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CompleteSnapshotCommandOutput>

  • Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

    Parameters

    Returns void

  • Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

    Parameters

    Returns void

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getSnapshotBlock

listChangedBlocks

listSnapshotBlocks

putSnapshotBlock

  • Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

    Data written to a snapshot must be aligned with 512-KiB sectors.

    Parameters

    Returns Promise<PutSnapshotBlockCommandOutput>

  • Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

    Data written to a snapshot must be aligned with 512-KiB sectors.

    Parameters

    Returns void

  • Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

    Data written to a snapshot must be aligned with 512-KiB sectors.

    Parameters

    Returns void

  • Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

    Data written to a snapshot must be aligned with 512-KiB sectors.

    Parameters

    • args: PutSnapshotBlockCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutSnapshotBlockCommandOutput>

  • Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

    Data written to a snapshot must be aligned with 512-KiB sectors.

    Parameters

    Returns void

  • Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

    Data written to a snapshot must be aligned with 512-KiB sectors.

    Parameters

    Returns void

send

startSnapshot