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(value="software.amazon.awssdk:codegen")
public final class CreateSnapshotRequest
extends Ec2Request
implements ToCopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateSnapshotRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateSnapshotRequest.Builder	builder()
String	description() A description for the snapshot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications() Returns true if the TagSpecifications 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	outpostArn() The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.
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 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()

The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.

• To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

• To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

• To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Returns:

The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.

• To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

• To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

• To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

volumeId

public final String volumeId()

The ID of the EBS volume.

Returns:

The ID of the EBS volume.

hasTagSpecifications

public final boolean hasTagSpecifications()

Returns true if the TagSpecifications 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.

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.

You can use hasTagSpecifications() to see if a value was sent in this field.

Returns:

The tags to apply to the snapshot during creation.

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