CopySnapshotRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CopySnapshotRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CopySnapshotRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CopySnapshotRequest.Builder`	`builder()`
`String`	`description()` A description for the EBS snapshot.
`String`	`destinationRegion()` The destination Region to use in the `PresignedUrl` parameter of a snapshot copy operation.
`Boolean`	`encrypted()` To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
`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`	`kmsKeyId()` The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
`String`	`presignedUrl()` When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CopySnapshotRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceRegion()` The ID of the Region that contains the snapshot to be copied.
`String`	`sourceSnapshotId()` The ID of the EBS snapshot to copy.
`List<TagSpecification>`	`tagSpecifications()` The tags to apply to the new snapshot.
`CopySnapshotRequest.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 String description()
```
    A description for the EBS snapshot.
    
    Returns:
    
    A description for the EBS snapshot.
  - destinationRegion
```
public String destinationRegion()
```
    The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
    
    The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.
    
    Returns:
    
    The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
    
    The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.
  - encrypted
```
public Boolean encrypted()
```
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
  - kmsKeyId
```
public String kmsKeyId()
```
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.
    
    You can specify the CMK using any of the following:
    - Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - Key alias. For example, alias/ExampleAlias.
    - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
    - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
    AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
    Returns:
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.
    
    You can specify the CMK using any of the following:
    
    Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Key alias. For example, alias/ExampleAlias.
    
    Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
    
    Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
    
    AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
  - presignedUrl
```
public String presignedUrl()
```
    When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.
    
    The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
    
    Returns:
    
    When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.
    
    The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
  - sourceRegion
```
public String sourceRegion()
```
    The ID of the Region that contains the snapshot to be copied.
    
    Returns:
    
    The ID of the Region that contains the snapshot to be copied.
  - sourceSnapshotId
```
public String sourceSnapshotId()
```
    The ID of the EBS snapshot to copy.
    
    Returns:
    
    The ID of the EBS snapshot to copy.
  - hasTagSpecifications
```
public 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 List<TagSpecification> tagSpecifications()
```
    The tags to apply to the new snapshot.
    
    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 new snapshot.
  - toBuilder
```
public CopySnapshotRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CopySnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CopySnapshotRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CopySnapshotRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

description

destinationRegion

encrypted

kmsKeyId

presignedUrl

sourceRegion

sourceSnapshotId

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields