/* * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.CopySnapshotRequestMarshaller; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#copySnapshot(CopySnapshotRequest) CopySnapshot operation}. *
* Copies a point-in-time snapshot of an EBS volume and stores it in * Amazon S3. You can copy the snapshot within the same region or from * one region to another. You can use the snapshot to create EBS volumes * or Amazon Machine Images (AMIs). The snapshot is copied to the * regional endpoint that you send the HTTP request to. *
*
 * Copies of encrypted EBS snapshots remain encrypted. Copies of
 * unencrypted snapshots remain unencrypted, unless the
 * Encrypted flag is specified during the snapshot copy
 * operation. By default, encrypted snapshot copies use the default AWS
 * Key Management Service (AWS KMS) customer master key (CMK); however,
 * you can specify a non-default CMK with the KmsKeyId
 * parameter.
 * 
* For more information, see * Copying an Amazon EBS Snapshot * in the Amazon Elastic Compute Cloud User Guide . *
* * @see com.amazonaws.services.ec2.AmazonEC2#copySnapshot(CopySnapshotRequest) */ public class CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequestPresignedUrl
     * parameter of a snapshot copy operation. This parameter is only valid
     * for specifying the destination region in a PresignedUrl
     * parameter, where it is required. CopySnapshot
     * sends the snapshot copy to the regional endpoint that you send the
     * HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     * the AWS CLI, this is specified with the --region
     * parameter or the default region in your AWS configuration file).
     * 
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.
     */
    private String presignedUrl;
    /**
     * Specifies whether the destination snapshot should be encrypted. There
     * is no way to create an unencrypted snapshot copy from an encrypted
     * snapshot; however, you can encrypt a copy of an unencrypted snapshot
     * with this flag. The default CMK for EBS is used unless a non-default
     * AWS Key Management Service (AWS KMS) CMK is specified with
     * KmsKeyId. For more information, see Amazon
     * EBS Encryption in the Amazon Elastic Compute Cloud User
     * Guide.
     */
    private Boolean encrypted;
    /**
     * The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     * when creating the snapshot copy. This parameter is only required if
     * you want to use a non-default CMK; if this parameter is not specified,
     * the default CMK for EBS is used. The ARN contains the
     * arn:aws:kms namespace, followed by the region of the CMK,
     * the AWS account ID of the CMK owner, the key namespace,
     * and then the CMK ID. For example,
     * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     * The specified CMK must exist in the region that the snapshot is being
     * copied to. If a KmsKeyId is specified, the
     * Encrypted flag must also be set.
     */
    private String kmsKeyId;
    /**
     * The ID of the region that contains the snapshot to be copied.
     *
     * @return The ID of the region that contains the snapshot to be copied.
     */
    public String getSourceRegion() {
        return sourceRegion;
    }
    
    /**
     * The ID of the region that contains the snapshot to be copied.
     *
     * @param sourceRegion The ID of the region that contains the snapshot to be copied.
     */
    public void setSourceRegion(String sourceRegion) {
        this.sourceRegion = sourceRegion;
    }
    
    /**
     * The ID of the region that contains the snapshot to be copied.
     * * Returns a reference to this object so that method calls can be chained together. * * @param sourceRegion The ID of the region that contains the snapshot to be copied. * * @return A reference to this updated object so that method calls can be chained * together. */ public CopySnapshotRequest withSourceRegion(String sourceRegion) { this.sourceRegion = sourceRegion; return this; } /** * The ID of the EBS snapshot to copy. * * @return The ID of the EBS snapshot to copy. */ public String getSourceSnapshotId() { return sourceSnapshotId; } /** * The ID of the EBS snapshot to copy. * * @param sourceSnapshotId The ID of the EBS snapshot to copy. */ public void setSourceSnapshotId(String sourceSnapshotId) { this.sourceSnapshotId = sourceSnapshotId; } /** * The ID of the EBS snapshot to copy. *
* Returns a reference to this object so that method calls can be chained together. * * @param sourceSnapshotId The ID of the EBS snapshot to copy. * * @return A reference to this updated object so that method calls can be chained * together. */ public CopySnapshotRequest withSourceSnapshotId(String sourceSnapshotId) { this.sourceSnapshotId = sourceSnapshotId; return this; } /** * A description for the EBS snapshot. * * @return A description for the EBS snapshot. */ public String getDescription() { return description; } /** * A description for the EBS snapshot. * * @param description A description for the EBS snapshot. */ public void setDescription(String description) { this.description = description; } /** * A description for the EBS snapshot. *
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param description A description for the EBS snapshot.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CopySnapshotRequest withDescription(String description) {
        this.description = description;
        return this;
    }
    /**
     * 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. CopySnapshot
     * sends the snapshot copy to the regional endpoint that you send the
     * HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     * the AWS CLI, this is specified with the --region
     * parameter or the default region in your AWS configuration file).
     * 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. CopySnapshot
     *         sends the snapshot copy to the regional endpoint that you send the
     *         HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     *         the AWS CLI, this is specified with the --region
     *         parameter or the default region in your AWS configuration file).
     *         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. CopySnapshot
     * sends the snapshot copy to the regional endpoint that you send the
     * HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     * the AWS CLI, this is specified with the --region
     * parameter or the default region in your AWS configuration file).
     * 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. CopySnapshot
     *         sends the snapshot copy to the regional endpoint that you send the
     *         HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     *         the AWS CLI, this is specified with the --region
     *         parameter or the default region in your AWS configuration file).
     *         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. CopySnapshot
     * sends the snapshot copy to the regional endpoint that you send the
     * HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     * the AWS CLI, this is specified with the --region
     * parameter or the default region in your AWS configuration file).
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param 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. CopySnapshot
     *         sends the snapshot copy to the regional endpoint that you send the
     *         HTTP request to, such as ec2.us-east-1.amazonaws.com (in
     *         the AWS CLI, this is specified with the --region
     *         parameter or the default region in your AWS configuration file).
     *         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.
     *
     * @return The pre-signed URL that facilitates copying an encrypted snapshot.
     *         This parameter is only required when copying an encrypted snapshot
     *         with the Amazon EC2 Query API; it is available as an optional
     *         parameter in all other cases. 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.
     */
    public String getPresignedUrl() {
        return presignedUrl;
    }
    
    /**
     * The pre-signed URL that facilitates copying an encrypted snapshot.
     * This parameter is only required when copying an encrypted snapshot
     * with the Amazon EC2 Query API; it is available as an optional
     * parameter in all other cases. 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.
     *
     * @param presignedUrl The pre-signed URL that facilitates copying an encrypted snapshot.
     *         This parameter is only required when copying an encrypted snapshot
     *         with the Amazon EC2 Query API; it is available as an optional
     *         parameter in all other cases. 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.
     */
    public void setPresignedUrl(String presignedUrl) {
        this.presignedUrl = presignedUrl;
    }
    
    /**
     * The pre-signed URL that facilitates copying an encrypted snapshot.
     * This parameter is only required when copying an encrypted snapshot
     * with the Amazon EC2 Query API; it is available as an optional
     * parameter in all other cases. 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 a reference to this object so that method calls can be chained together.
     *
     * @param presignedUrl The pre-signed URL that facilitates copying an encrypted snapshot.
     *         This parameter is only required when copying an encrypted snapshot
     *         with the Amazon EC2 Query API; it is available as an optional
     *         parameter in all other cases. 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CopySnapshotRequest withPresignedUrl(String presignedUrl) {
        this.presignedUrl = presignedUrl;
        return this;
    }
    /**
     * Specifies whether the destination snapshot should be encrypted. There
     * is no way to create an unencrypted snapshot copy from an encrypted
     * snapshot; however, you can encrypt a copy of an unencrypted snapshot
     * with this flag. The default CMK for EBS is used unless a non-default
     * AWS Key Management Service (AWS KMS) CMK is specified with
     * KmsKeyId. For more information, see Amazon
     * EBS Encryption in the Amazon Elastic Compute Cloud User
     * Guide.
     *
     * @return Specifies whether the destination snapshot should be encrypted. There
     *         is no way to create an unencrypted snapshot copy from an encrypted
     *         snapshot; however, you can encrypt a copy of an unencrypted snapshot
     *         with this flag. The default CMK for EBS is used unless a non-default
     *         AWS Key Management Service (AWS KMS) CMK is specified with
     *         KmsKeyId. For more information, see Amazon
     *         EBS Encryption in the Amazon Elastic Compute Cloud User
     *         Guide.
     */
    public Boolean isEncrypted() {
        return encrypted;
    }
    
    /**
     * Specifies whether the destination snapshot should be encrypted. There
     * is no way to create an unencrypted snapshot copy from an encrypted
     * snapshot; however, you can encrypt a copy of an unencrypted snapshot
     * with this flag. The default CMK for EBS is used unless a non-default
     * AWS Key Management Service (AWS KMS) CMK is specified with
     * KmsKeyId. For more information, see Amazon
     * EBS Encryption in the Amazon Elastic Compute Cloud User
     * Guide.
     *
     * @param encrypted Specifies whether the destination snapshot should be encrypted. There
     *         is no way to create an unencrypted snapshot copy from an encrypted
     *         snapshot; however, you can encrypt a copy of an unencrypted snapshot
     *         with this flag. The default CMK for EBS is used unless a non-default
     *         AWS Key Management Service (AWS KMS) CMK is specified with
     *         KmsKeyId. For more information, see Amazon
     *         EBS Encryption in the Amazon Elastic Compute Cloud User
     *         Guide.
     */
    public void setEncrypted(Boolean encrypted) {
        this.encrypted = encrypted;
    }
    
    /**
     * Specifies whether the destination snapshot should be encrypted. There
     * is no way to create an unencrypted snapshot copy from an encrypted
     * snapshot; however, you can encrypt a copy of an unencrypted snapshot
     * with this flag. The default CMK for EBS is used unless a non-default
     * AWS Key Management Service (AWS KMS) CMK is specified with
     * KmsKeyId. For more information, see Amazon
     * EBS Encryption in the Amazon Elastic Compute Cloud User
     * Guide.
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param encrypted Specifies whether the destination snapshot should be encrypted. There
     *         is no way to create an unencrypted snapshot copy from an encrypted
     *         snapshot; however, you can encrypt a copy of an unencrypted snapshot
     *         with this flag. The default CMK for EBS is used unless a non-default
     *         AWS Key Management Service (AWS KMS) CMK is specified with
     *         KmsKeyId. For more information, see Amazon
     *         EBS Encryption in the Amazon Elastic Compute Cloud User
     *         Guide.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CopySnapshotRequest withEncrypted(Boolean encrypted) {
        this.encrypted = encrypted;
        return this;
    }
    /**
     * Specifies whether the destination snapshot should be encrypted. There
     * is no way to create an unencrypted snapshot copy from an encrypted
     * snapshot; however, you can encrypt a copy of an unencrypted snapshot
     * with this flag. The default CMK for EBS is used unless a non-default
     * AWS Key Management Service (AWS KMS) CMK is specified with
     * KmsKeyId. For more information, see Amazon
     * EBS Encryption in the Amazon Elastic Compute Cloud User
     * Guide.
     *
     * @return Specifies whether the destination snapshot should be encrypted. There
     *         is no way to create an unencrypted snapshot copy from an encrypted
     *         snapshot; however, you can encrypt a copy of an unencrypted snapshot
     *         with this flag. The default CMK for EBS is used unless a non-default
     *         AWS Key Management Service (AWS KMS) CMK is specified with
     *         KmsKeyId. For more information, see Amazon
     *         EBS Encryption in the Amazon Elastic Compute Cloud User
     *         Guide.
     */
    public Boolean getEncrypted() {
        return encrypted;
    }
    /**
     * The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     * when creating the snapshot copy. This parameter is only required if
     * you want to use a non-default CMK; if this parameter is not specified,
     * the default CMK for EBS is used. The ARN contains the
     * arn:aws:kms namespace, followed by the region of the CMK,
     * the AWS account ID of the CMK owner, the key namespace,
     * and then the CMK ID. For example,
     * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     * The specified CMK must exist in the region that the snapshot is being
     * copied to. If a KmsKeyId is specified, the
     * Encrypted flag must also be set.
     *
     * @return The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     *         when creating the snapshot copy. This parameter is only required if
     *         you want to use a non-default CMK; if this parameter is not specified,
     *         the default CMK for EBS is used. The ARN contains the
     *         arn:aws:kms namespace, followed by the region of the CMK,
     *         the AWS account ID of the CMK owner, the key namespace,
     *         and then the CMK ID. For example,
     *         arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     *         The specified CMK must exist in the region that the snapshot is being
     *         copied to. If a KmsKeyId is specified, the
     *         Encrypted flag must also be set.
     */
    public String getKmsKeyId() {
        return kmsKeyId;
    }
    
    /**
     * The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     * when creating the snapshot copy. This parameter is only required if
     * you want to use a non-default CMK; if this parameter is not specified,
     * the default CMK for EBS is used. The ARN contains the
     * arn:aws:kms namespace, followed by the region of the CMK,
     * the AWS account ID of the CMK owner, the key namespace,
     * and then the CMK ID. For example,
     * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     * The specified CMK must exist in the region that the snapshot is being
     * copied to. If a KmsKeyId is specified, the
     * Encrypted flag must also be set.
     *
     * @param kmsKeyId The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     *         when creating the snapshot copy. This parameter is only required if
     *         you want to use a non-default CMK; if this parameter is not specified,
     *         the default CMK for EBS is used. The ARN contains the
     *         arn:aws:kms namespace, followed by the region of the CMK,
     *         the AWS account ID of the CMK owner, the key namespace,
     *         and then the CMK ID. For example,
     *         arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     *         The specified CMK must exist in the region that the snapshot is being
     *         copied to. If a KmsKeyId is specified, the
     *         Encrypted flag must also be set.
     */
    public void setKmsKeyId(String kmsKeyId) {
        this.kmsKeyId = kmsKeyId;
    }
    
    /**
     * The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     * when creating the snapshot copy. This parameter is only required if
     * you want to use a non-default CMK; if this parameter is not specified,
     * the default CMK for EBS is used. The ARN contains the
     * arn:aws:kms namespace, followed by the region of the CMK,
     * the AWS account ID of the CMK owner, the key namespace,
     * and then the CMK ID. For example,
     * arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     * The specified CMK must exist in the region that the snapshot is being
     * copied to. If a KmsKeyId is specified, the
     * Encrypted flag must also be set.
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param kmsKeyId The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
     *         when creating the snapshot copy. This parameter is only required if
     *         you want to use a non-default CMK; if this parameter is not specified,
     *         the default CMK for EBS is used. The ARN contains the
     *         arn:aws:kms namespace, followed by the region of the CMK,
     *         the AWS account ID of the CMK owner, the key namespace,
     *         and then the CMK ID. For example,
     *         arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
     *         The specified CMK must exist in the region that the snapshot is being
     *         copied to. If a KmsKeyId is specified, the
     *         Encrypted flag must also be set.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CopySnapshotRequest withKmsKeyId(String kmsKeyId) {
        this.kmsKeyId = kmsKeyId;
        return this;
    }
    /**
     * This method is intended for internal use only.
     * Returns the marshaled request configured with additional parameters to
     * enable operation dry-run.
     */
    @Override
    public Request