com.amazonaws.services.ec2.model

Class CreateSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateSnapshotsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateSnapshotsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
CreateSnapshotsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCopyTagsFromSource() Copies the tags from the specified volume to corresponding snapshot.
String	getDescription() A description propagated to every snapshot specified by the instance.
Request<CreateSnapshotsRequest>	getDryRunRequest() This method is intended for internal use only.
InstanceSpecification	getInstanceSpecification() The instance to specify which volumes should be included in the snapshots.
String	getOutpostArn() The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
List<TagSpecification>	getTagSpecifications() Tags to apply to every snapshot specified by the instance.
int	hashCode()
void	setCopyTagsFromSource(String copyTagsFromSource) Copies the tags from the specified volume to corresponding snapshot.
void	setDescription(String description) A description propagated to every snapshot specified by the instance.
void	setInstanceSpecification(InstanceSpecification instanceSpecification) The instance to specify which volumes should be included in the snapshots.
void	setOutpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) Tags to apply to every snapshot specified by the instance.
String	toString() Returns a string representation of this object.
CreateSnapshotsRequest	withCopyTagsFromSource(CopyTagsFromSource copyTagsFromSource) Copies the tags from the specified volume to corresponding snapshot.
CreateSnapshotsRequest	withCopyTagsFromSource(String copyTagsFromSource) Copies the tags from the specified volume to corresponding snapshot.
CreateSnapshotsRequest	withDescription(String description) A description propagated to every snapshot specified by the instance.
CreateSnapshotsRequest	withInstanceSpecification(InstanceSpecification instanceSpecification) The instance to specify which volumes should be included in the snapshots.
CreateSnapshotsRequest	withOutpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
CreateSnapshotsRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) Tags to apply to every snapshot specified by the instance.
CreateSnapshotsRequest	withTagSpecifications(TagSpecification... tagSpecifications) Tags to apply to every snapshot specified by the instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSnapshotsRequest

public CreateSnapshotsRequest()

Method Detail

setDescription

public void setDescription(String description)

A description propagated to every snapshot specified by the instance.

Parameters:

description - A description propagated to every snapshot specified by the instance.

getDescription

public String getDescription()

A description propagated to every snapshot specified by the instance.

Returns:

A description propagated to every snapshot specified by the instance.

withDescription

public CreateSnapshotsRequest withDescription(String description)

A description propagated to every snapshot specified by the instance.

Parameters:

description - A description propagated to every snapshot specified by the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceSpecification

public void setInstanceSpecification(InstanceSpecification instanceSpecification)

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

Parameters:

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

getInstanceSpecification

public InstanceSpecification getInstanceSpecification()

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.

withInstanceSpecification

public CreateSnapshotsRequest withInstanceSpecification(InstanceSpecification instanceSpecification)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutpostArn

public void setOutpostArn(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 EBS User Guide.

Parameters:

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 EBS User Guide.

getOutpostArn

public String getOutpostArn()

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 EBS 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 EBS User Guide.

withOutpostArn

public CreateSnapshotsRequest withOutpostArn(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 EBS User Guide.

Parameters:

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 EBS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

Tags to apply to every snapshot specified by the instance.

Returns:

Tags to apply to every snapshot specified by the instance.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

Tags to apply to every snapshot specified by the instance.

Parameters:

tagSpecifications - Tags to apply to every snapshot specified by the instance.

withTagSpecifications

public CreateSnapshotsRequest withTagSpecifications(TagSpecification... tagSpecifications)

Tags to apply to every snapshot specified by the instance.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - Tags to apply to every snapshot specified by the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagSpecifications

public CreateSnapshotsRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

Tags to apply to every snapshot specified by the instance.

Parameters:

tagSpecifications - Tags to apply to every snapshot specified by the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCopyTagsFromSource

public void setCopyTagsFromSource(String copyTagsFromSource)

Copies the tags from the specified volume to corresponding snapshot.

Parameters:

copyTagsFromSource - Copies the tags from the specified volume to corresponding snapshot.

See Also:

CopyTagsFromSource

getCopyTagsFromSource

public String getCopyTagsFromSource()

Copies the tags from the specified volume to corresponding snapshot.

Returns:

Copies the tags from the specified volume to corresponding snapshot.

See Also:

CopyTagsFromSource

withCopyTagsFromSource

public CreateSnapshotsRequest withCopyTagsFromSource(String copyTagsFromSource)

Copies the tags from the specified volume to corresponding snapshot.

Parameters:

copyTagsFromSource - Copies the tags from the specified volume to corresponding snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CopyTagsFromSource

withCopyTagsFromSource

public CreateSnapshotsRequest withCopyTagsFromSource(CopyTagsFromSource copyTagsFromSource)

Copies the tags from the specified volume to corresponding snapshot.

Parameters:

copyTagsFromSource - Copies the tags from the specified volume to corresponding snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CopyTagsFromSource

getDryRunRequest

public Request<CreateSnapshotsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateSnapshotsRequest>

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateSnapshotsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()