Class CreateSnapshotResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.ec2.model.Ec2Response
-
- software.amazon.awssdk.services.ec2.model.CreateSnapshotResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateSnapshotResponse.Builder,CreateSnapshotResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateSnapshotResponse extends Ec2Response implements ToCopyableBuilder<CreateSnapshotResponse.Builder,CreateSnapshotResponse>
Describes a snapshot.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateSnapshotResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateSnapshotResponse.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()
For responses, this returns true if the service returned a value for the Tags property.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 Amazon Web Services account that owns the EBS snapshot.String
progress()
The progress of the snapshot, as a percentage.Instant
restoreExpiryTime()
Only for archived snapshots that are temporarily restored.List<SdkField<?>>
sdkFields()
static Class<? extends CreateSnapshotResponse.Builder>
serializableBuilderClass()
String
snapshotId()
The ID of the snapshot.SSEType
sseType()
Reserved for future use.String
sseTypeAsString()
Reserved for future use.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.StorageTier
storageTier()
The storage tier in which the snapshot is stored.String
storageTierAsString()
The storage tier in which the snapshot is stored.List<Tag>
tags()
Any tags assigned to the snapshot.CreateSnapshotResponse.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 software.amazon.awssdk.services.ec2.model.Ec2Response
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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 Amazon Web Services account that owns the EBS snapshot.
- Returns:
- The ID of the Amazon Web Services 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 returnSnapshotState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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 returnSnapshotState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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 Amazon Web Services 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 Amazon Web Services 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()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Any tags assigned to the snapshot.
-
storageTier
public final StorageTier storageTier()
The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used.If the service returns an enum value that is not available in the current SDK version,
storageTier
will returnStorageTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTierAsString()
.- Returns:
- The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used. - See Also:
StorageTier
-
storageTierAsString
public final String storageTierAsString()
The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used.If the service returns an enum value that is not available in the current SDK version,
storageTier
will returnStorageTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTierAsString()
.- Returns:
- The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used. - See Also:
StorageTier
-
restoreExpiryTime
public final Instant restoreExpiryTime()
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
- Returns:
- Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
-
sseType
public final SSEType sseType()
Reserved for future use.
If the service returns an enum value that is not available in the current SDK version,
sseType
will returnSSEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsseTypeAsString()
.- Returns:
- Reserved for future use.
- See Also:
SSEType
-
sseTypeAsString
public final String sseTypeAsString()
Reserved for future use.
If the service returns an enum value that is not available in the current SDK version,
sseType
will returnSSEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsseTypeAsString()
.- Returns:
- Reserved for future use.
- See Also:
SSEType
-
toBuilder
public CreateSnapshotResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateSnapshotResponse.Builder,CreateSnapshotResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static CreateSnapshotResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateSnapshotResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-