Snapshot (AWS Java SDK :: Services :: Amazon EC2 2.17.7 API)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.Snapshot

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Snapshot.Builder,Snapshot>

@Generated(value="software.amazon.awssdk:codegen")
public final class Snapshot
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Snapshot.Builder,Snapshot>

Describes a snapshot.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Snapshot.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Snapshot.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Snapshot.Builder`	`builder()`
`String`	`dataEncryptionKeyId()` The data encryption key identifier for the snapshot.
`String`	`description()` The description for the snapshot.
`Boolean`	`encrypted()` Indicates whether the snapshot is encrypted.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKeyId()` The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
`String`	`outpostArn()` The ARN of the Outpost on which the snapshot is stored.
`String`	`ownerAlias()` The Amazon Web Services owner alias, from an Amazon-maintained list (`amazon`).
`String`	`ownerId()` The ID of the account that owns the EBS snapshot.
`String`	`progress()` The progress of the snapshot, as a percentage.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Snapshot.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()` The ID of the snapshot.
`Instant`	`startTime()` The time stamp when the snapshot was initiated.
`SnapshotState`	`state()` The snapshot state.
`String`	`stateAsString()` The snapshot state.
`String`	`stateMessage()` Encrypted Amazon EBS snapshots are copied asynchronously.
`List<Tag>`	`tags()` Any tags assigned to the snapshot.
`Snapshot.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeId()` The ID of the volume that was used to create the snapshot.
`Integer`	`volumeSize()` The size of the volume, in GiB.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dataEncryptionKeyId
```
public final String dataEncryptionKeyId()
```
    The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
    
    Returns:
    
    The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
  - description
```
public final String description()
```
    The description for the snapshot.
    
    Returns:
    
    The description for the snapshot.
  - encrypted
```
public final Boolean encrypted()
```
    Indicates whether the snapshot is encrypted.
    
    Returns:
    
    Indicates whether the snapshot is encrypted.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
  - ownerId
```
public final String ownerId()
```
    The ID of the account that owns the EBS snapshot.
    
    Returns:
    
    The ID of the account that owns the EBS snapshot.
  - progress
```
public final String progress()
```
    The progress of the snapshot, as a percentage.
    
    Returns:
    
    The progress of the snapshot, as a percentage.
  - snapshotId
```
public final String snapshotId()
```
    The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
    
    Returns:
    
    The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
  - startTime
```
public final Instant startTime()
```
    The time stamp when the snapshot was initiated.
    
    Returns:
    
    The time stamp when the snapshot was initiated.
  - state
```
public final SnapshotState state()
```
    The snapshot state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The snapshot state.
    
    See Also:
    
    SnapshotState
  - stateAsString
```
public final String stateAsString()
```
    The snapshot state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return SnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The snapshot state.
    
    See Also:
    
    SnapshotState
  - stateMessage
```
public final String stateMessage()
```
    Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
    
    Returns:
    
    Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
  - volumeId
```
public final String volumeId()
```
    The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
    
    Returns:
    
    The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
  - volumeSize
```
public final Integer volumeSize()
```
    The size of the volume, in GiB.
    
    Returns:
    
    The size of the volume, in GiB.
  - ownerAlias
```
public final String ownerAlias()
```
    The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured account alias set using the IAM console.
    
    Returns:
    
    The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured account alias set using the IAM console.
  - outpostArn
```
public final String outpostArn()
```
    The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    Any tags assigned to the snapshot.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Any tags assigned to the snapshot.
  - toBuilder
```
public Snapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
  - builder
```
public static Snapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Snapshot.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Snapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dataEncryptionKeyId

description

encrypted

kmsKeyId

ownerId

progress

snapshotId

startTime

state

stateAsString

stateMessage

volumeId

volumeSize

ownerAlias

outpostArn

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields