software.amazon.awssdk.services.ec2.model

Class CreateSnapshotsRequest

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.CreateSnapshotsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSnapshotsRequest.Builder,CreateSnapshotsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateSnapshotsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateSnapshotsRequest.Builder	builder()
CopyTagsFromSource	copyTagsFromSource() Copies the tags from the specified volume to corresponding snapshot.
String	copyTagsFromSourceAsString() Copies the tags from the specified volume to corresponding snapshot.
String	description() A description propagated to every snapshot specified by the instance.
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.
InstanceSpecification	instanceSpecification() The instance to specify which volumes should be included in the snapshots.
String	outpostArn() The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSnapshotsRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications() Tags to apply to every snapshot specified by the instance.
CreateSnapshotsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 propagated to every snapshot specified by the instance.

Returns:

A description propagated to every snapshot specified by the instance.

instanceSpecification

public final InstanceSpecification instanceSpecification()

The instance to specify which volumes should be included in the snapshots.

Returns:

The instance to specify which volumes should be included in the snapshots.

outpostArn

public final String outpostArn()

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

• To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

• To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

• To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

• To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

• To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

• To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

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()

Tags to apply to every snapshot specified by the instance.

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:

Tags to apply to every snapshot specified by the instance.

copyTagsFromSource

public final CopyTagsFromSource copyTagsFromSource()

Copies the tags from the specified volume to corresponding snapshot.

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

Returns:

Copies the tags from the specified volume to corresponding snapshot.

See Also:

CopyTagsFromSource

copyTagsFromSourceAsString

public final String copyTagsFromSourceAsString()

Copies the tags from the specified volume to corresponding snapshot.

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

Returns:

Copies the tags from the specified volume to corresponding snapshot.

See Also:

CopyTagsFromSource

toBuilder

public CreateSnapshotsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSnapshotsRequest.Builder,CreateSnapshotsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateSnapshotsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSnapshotsRequest.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