com.amazonaws.services.storagegateway.model

## クラス CreateSnapshotRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.storagegateway.model.CreateSnapshotRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class CreateSnapshotRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `CreateSnapshot operation`.

  This operation initiates a snapshot of a volume.

  AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.

  In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

  NOTE:To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DeleteSnapshot and DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

  関連項目:
    `AWSStorageGateway.createSnapshot(CreateSnapshotRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `CreateSnapshotRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getSnapshotDescription()` Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field Constraints: Length: 1 - 255
    `java.lang.String` | `getVolumeARN()` The Amazon Resource Name (ARN) of the volume.
    `int` | `hashCode()`
    `void` | `setSnapshotDescription(java.lang.String snapshotDescription)` Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field Constraints: Length: 1 - 255
    `void` | `setVolumeARN(java.lang.String volumeARN)` The Amazon Resource Name (ARN) of the volume.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `CreateSnapshotRequest` | `withSnapshotDescription(java.lang.String snapshotDescription)` Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field Returns a reference to this object so that method calls can be chained together.
    `CreateSnapshotRequest` | `withVolumeARN(java.lang.String volumeARN)` The Amazon Resource Name (ARN) of the volume.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### CreateSnapshotRequest

          public CreateSnapshotRequest()

  - ### メソッドの詳細

    - #### getVolumeARN

          public java.lang.String getVolumeARN()

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

      Constraints:
      Length: 50 - 500

      戻り値:
        The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    - #### setVolumeARN

          public void setVolumeARN(java.lang.String volumeARN)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

      Constraints:
      Length: 50 - 500

      パラメータ:
        `volumeARN` - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    - #### withVolumeARN

          public CreateSnapshotRequest withVolumeARN(java.lang.String volumeARN)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 50 - 500

      パラメータ:
        `volumeARN` - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    - #### getSnapshotDescription

          public java.lang.String getSnapshotDescription()

      Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

      Constraints:
      Length: 1 - 255

      戻り値:
        Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

    - #### setSnapshotDescription

          public void setSnapshotDescription(java.lang.String snapshotDescription)

      Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

      Constraints:
      Length: 1 - 255

      パラメータ:
        `snapshotDescription` - Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

    - #### withSnapshotDescription

          public CreateSnapshotRequest withSnapshotDescription(java.lang.String snapshotDescription)

      Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 1 - 255

      パラメータ:
        `snapshotDescription` - Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`