Package software.amazon.awssdk.services.ec2.model

Class Snapshot

java.lang.Object

software.amazon.awssdk.services.ec2.model.Snapshot

All Implemented Interfaces:

ToCopyableBuilder<Snapshot.Builder,Snapshot>

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

Describes a snapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Snapshot.Builder

Method Summary

Modifier and Type	Method	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)
int	hashCode()
String	kmsKeyId()	The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
String	ownerAlias()	Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft ) of snapshot owners.
String	ownerId()	The AWS account ID of the EBS snapshot owner.
String	progress()	The progress of the snapshot, as a percentage.
static Class<? extends Snapshot.Builder>	serializableBuilderClass()
String	snapshotId()	The ID of the snapshot.
Date	startTime()	The time stamp when the snapshot was initiated.
String	state()	The snapshot state.
String	stateMessage()	Encrypted Amazon EBS snapshots are copied asynchronously.
List<Tag>	tags()	Any tags assigned to the snapshot.
Snapshot.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dataEncryptionKeyId

public 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 the DescribeSnapshots API operation.

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 the DescribeSnapshots API operation.

description

public String description()

The description for the snapshot.

Returns:

The description for the snapshot.

encrypted

public Boolean encrypted()

Indicates whether the snapshot is encrypted.

Returns:

Indicates whether the snapshot is encrypted.

kmsKeyId

public String kmsKeyId()

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Returns:

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

ownerId

public String ownerId()

The AWS account ID of the EBS snapshot owner.

Returns:

The AWS account ID of the EBS snapshot owner.

progress

public String progress()

The progress of the snapshot, as a percentage.

Returns:

The progress of the snapshot, as a percentage.

snapshotId

public 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 Date startTime()

The time stamp when the snapshot was initiated.

Returns:

The time stamp when the snapshot was initiated.

state

public String state()

The snapshot state.

Returns:

The snapshot state.

See Also:

SnapshotState

stateMessage

public String stateMessage()

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS 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 the DescribeSnapshots API operation.

Returns:

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS 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 the DescribeSnapshots API operation.

volumeId

public 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 Integer volumeSize()

The size of the volume, in GiB.

Returns:

The size of the volume, in GiB.

ownerAlias

public String ownerAlias()

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft ) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

Returns:

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

tags

public List<Tag> tags()

Any tags assigned to the snapshot.

Returns:

Any tags assigned to the snapshot.

toBuilder

public Snapshot.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>

Returns:

a builder for type T

builder

public static Snapshot.Builder builder()

serializableBuilderClass

public static Class<? extends Snapshot.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object