CreateSnapshotRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.CreateSnapshotRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateSnapshotRequest>, Serializable, Cloneable

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

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`CreateSnapshotRequest()` Default constructor for CreateSnapshotRequest object.
`CreateSnapshotRequest(String volumeId, String description)` Constructs a new CreateSnapshotRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateSnapshotRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description for the snapshot.
`Request<CreateSnapshotRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getOutpostArn()` The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
`List<TagSpecification>`	`getTagSpecifications()` The tags to apply to the snapshot during creation.
`String`	`getVolumeId()` The ID of the Amazon EBS volume.
`int`	`hashCode()`
`void`	`setDescription(String description)` A description for the snapshot.
`void`	`setOutpostArn(String outpostArn)` The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
`void`	`setTagSpecifications(Collection<TagSpecification> tagSpecifications)` The tags to apply to the snapshot during creation.
`void`	`setVolumeId(String volumeId)` The ID of the Amazon EBS volume.
`String`	`toString()` Returns a string representation of this object.
`CreateSnapshotRequest`	`withDescription(String description)` A description for the snapshot.
`CreateSnapshotRequest`	`withOutpostArn(String outpostArn)` The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
`CreateSnapshotRequest`	`withTagSpecifications(Collection<TagSpecification> tagSpecifications)` The tags to apply to the snapshot during creation.
`CreateSnapshotRequest`	`withTagSpecifications(TagSpecification... tagSpecifications)` The tags to apply to the snapshot during creation.
`CreateSnapshotRequest`	`withVolumeId(String volumeId)` The ID of the Amazon EBS volume.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateSnapshotRequest
```
public CreateSnapshotRequest()
```
    Default constructor for CreateSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - CreateSnapshotRequest
```
public CreateSnapshotRequest(String volumeId,
                             String description)
```
    Constructs a new CreateSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    volumeId - The ID of the Amazon EBS volume.
    
    description - A description for the snapshot.
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    A description for the snapshot.
    
    Parameters:
    
    description - A description for the snapshot.
  - getDescription
```
public String getDescription()
```
    A description for the snapshot.
    
    Returns:
    
    A description for the snapshot.
  - withDescription
```
public CreateSnapshotRequest withDescription(String description)
```
    A description for the snapshot.
    
    Parameters:
    
    description - A description for the snapshot.
    
    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 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 Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
    Parameters:
    outpostArn - The Amazon Resource Name (ARN) of the 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 Create local snapshots from volumes 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 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 Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
    Returns:
    The Amazon Resource Name (ARN) of the 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 Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
  - withOutpostArn
```
public CreateSnapshotRequest withOutpostArn(String outpostArn)
```
    The Amazon Resource Name (ARN) of the 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 Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
    Parameters:
    outpostArn - The Amazon Resource Name (ARN) of the 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 Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeId
```
public void setVolumeId(String volumeId)
```
    The ID of the Amazon EBS volume.
    
    Parameters:
    
    volumeId - The ID of the Amazon EBS volume.
  - getVolumeId
```
public String getVolumeId()
```
    The ID of the Amazon EBS volume.
    
    Returns:
    
    The ID of the Amazon EBS volume.
  - withVolumeId
```
public CreateSnapshotRequest withVolumeId(String volumeId)
```
    The ID of the Amazon EBS volume.
    
    Parameters:
    
    volumeId - The ID of the Amazon EBS volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTagSpecifications
```
public List<TagSpecification> getTagSpecifications()
```
    The tags to apply to the snapshot during creation.
    
    Returns:
    
    The tags to apply to the snapshot during creation.
  - setTagSpecifications
```
public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)
```
    The tags to apply to the snapshot during creation.
    
    Parameters:
    
    tagSpecifications - The tags to apply to the snapshot during creation.
  - withTagSpecifications
```
public CreateSnapshotRequest withTagSpecifications(TagSpecification... tagSpecifications)
```
    The tags to apply to the snapshot during creation.
    
    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 - The tags to apply to the snapshot during creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTagSpecifications
```
public CreateSnapshotRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)
```
    The tags to apply to the snapshot during creation.
    
    Parameters:
    
    tagSpecifications - The tags to apply to the snapshot during creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<CreateSnapshotRequest> 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<CreateSnapshotRequest>
  - 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 CreateSnapshotRequest 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()

AWS SDK for Java 1.x API Reference - 1.12.773

Class CreateSnapshotRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateSnapshotRequest

CreateSnapshotRequest

Method Detail

setDescription

getDescription

withDescription

setOutpostArn

getOutpostArn

withOutpostArn

setVolumeId

getVolumeId

withVolumeId

getTagSpecifications

setTagSpecifications

withTagSpecifications

withTagSpecifications

getDryRunRequest

toString

equals

hashCode

clone