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

Class CreateSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSnapshotRequest.Builder	builder()
String	description()	A description for the snapshot.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications property.
SnapshotLocationEnum	location()
String	locationAsString()
String	outpostArn()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSnapshotRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications()	The tags to apply to the snapshot during creation.
CreateSnapshotRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeId()	The ID of the Amazon EBS volume.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

description

public final String description()

A description for the snapshot.

Returns:

A description for the snapshot.

outpostArn

public final String outpostArn()

Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.

• To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.

• To create the snapshot in the parent Region of the Outpost, omit this parameter.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

Returns:

Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.

• To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.

• To create the snapshot in the parent Region of the Outpost, omit this parameter.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

volumeId

public final String volumeId()

The ID of the Amazon EBS volume.

Returns:

The ID of the Amazon EBS volume.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to apply to the snapshot during creation.

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 hasTagSpecifications() method.

Returns:

The tags to apply to the snapshot during creation.

location

public final SnapshotLocationEnum location()

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

• To create a local snapshot in the same Local Zone as the source volume, specify local.

• To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

If the service returns an enum value that is not available in the current SDK version, location will return SnapshotLocationEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationAsString().

Returns:

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

• To create a local snapshot in the same Local Zone as the source volume, specify local.

• To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

See Also:

SnapshotLocationEnum

locationAsString

public final String locationAsString()

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

• To create a local snapshot in the same Local Zone as the source volume, specify local.

• To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

If the service returns an enum value that is not available in the current SDK version, location will return SnapshotLocationEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationAsString().

Returns:

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

• To create a local snapshot in the same Local Zone as the source volume, specify local.

• To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

See Also:

SnapshotLocationEnum

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

toBuilder

public CreateSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateSnapshotRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo