com.amazonaws.services.rds.model.CopyDBSnapshotRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2013-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.rds.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CopyDBSnapshotRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier for the source DB snapshot.
*
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
* you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the
* shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
* must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*
*/
private String sourceDBSnapshotIdentifier;
/**
*
* The identifier for the copy of the snapshot.
*
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*
*/
private String targetDBSnapshotIdentifier;
/**
*
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt
* the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB
* snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for
* this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination
* AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use
* encryption keys from one AWS Region in another AWS Region.
*
*/
private String kmsKeyId;
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is
* false.
*
*/
private Boolean copyTags;
/**
*
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
* source AWS Region that contains the source DB snapshot to copy.
*
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
* Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy
* an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
* the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
* contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
* the same one where the CopyDBSnapshot action is called that contains this presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
* you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that
* contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the
* DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
* the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is
* called in the destination AWS Region, and the action contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied.
* This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
* are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using
* Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*/
private String preSignedUrl;
/**
*
* The name of an option group to associate with the copy of the snapshot.
*
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a
* nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL
* Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations.
*
*/
private String optionGroupName;
/** The region where the source snapshot is located. */
private String sourceRegion;
/**
*
* The identifier for the source DB snapshot.
*
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
* you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the
* shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
* must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*
*
* @param sourceDBSnapshotIdentifier
* The identifier for the source DB snapshot.
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For
* example, you might specify
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN)
* of the shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS
* Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl
* parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*/
public void setSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier) {
this.sourceDBSnapshotIdentifier = sourceDBSnapshotIdentifier;
}
/**
*
* The identifier for the source DB snapshot.
*
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
* you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the
* shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
* must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*
*
* @return The identifier for the source DB snapshot.
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For
* example, you might specify
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name
* (ARN) of the shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS
* Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl
* parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*/
public String getSourceDBSnapshotIdentifier() {
return this.sourceDBSnapshotIdentifier;
}
/**
*
* The identifier for the source DB snapshot.
*
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example,
* you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the
* shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and
* must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*
*
* @param sourceDBSnapshotIdentifier
* The identifier for the source DB snapshot.
*
* If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For
* example, you might specify rds:mysql-instance1-snapshot-20130805.
*
*
* If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For
* example, you might specify
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
*
*
* If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN)
* of the shared DB snapshot.
*
*
* If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS
* Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl
* parameter.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the "available" state.
*
*
*
*
* Example: rds:mydb-2012-04-02-00-01
*
*
* Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withSourceDBSnapshotIdentifier(String sourceDBSnapshotIdentifier) {
setSourceDBSnapshotIdentifier(sourceDBSnapshotIdentifier);
return this;
}
/**
*
* The identifier for the copy of the snapshot.
*
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*
*
* @param targetDBSnapshotIdentifier
* The identifier for the copy of the snapshot.
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*/
public void setTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier) {
this.targetDBSnapshotIdentifier = targetDBSnapshotIdentifier;
}
/**
*
* The identifier for the copy of the snapshot.
*
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*
*
* @return The identifier for the copy of the snapshot.
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*/
public String getTargetDBSnapshotIdentifier() {
return this.targetDBSnapshotIdentifier;
}
/**
*
* The identifier for the copy of the snapshot.
*
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
*
*
* @param targetDBSnapshotIdentifier
* The identifier for the copy of the snapshot.
*
* Constraints:
*
*
* -
*
* Cannot be null, empty, or blank
*
*
* -
*
* Must contain from 1 to 255 letters, numbers, or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* Example: my-db-snapshot
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withTargetDBSnapshotIdentifier(String targetDBSnapshotIdentifier) {
setTargetDBSnapshotIdentifier(targetDBSnapshotIdentifier);
return this;
}
/**
*
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt
* the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB
* snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for
* this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination
* AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use
* encryption keys from one AWS Region in another AWS Region.
*
*
* @param kmsKeyId
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to
* encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the
* copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a
* value for this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the
* destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and
* you can't use encryption keys from one AWS Region in another AWS Region.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt
* the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB
* snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for
* this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination
* AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use
* encryption keys from one AWS Region in another AWS Region.
*
*
* @return The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS
* key identifier, or the KMS key alias for the KMS encryption key.
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to
* encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the
* copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a
* value for this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the
* destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and
* you can't use encryption keys from one AWS Region in another AWS Region.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt
* the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB
* snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for
* this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination
* AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use
* encryption keys from one AWS Region in another AWS Region.
*
*
* @param kmsKeyId
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key
* identifier, or the KMS key alias for the KMS encryption key.
*
* If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to
* encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the
* copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
*
*
* If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a
* value for this parameter.
*
*
* If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
*
*
* If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the
* destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and
* you can't use encryption keys from one AWS Region in another AWS Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
* @return
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
* @param tags
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is
* false.
*
*
* @param copyTags
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The
* default is false.
*/
public void setCopyTags(Boolean copyTags) {
this.copyTags = copyTags;
}
/**
*
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is
* false.
*
*
* @return True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The
* default is false.
*/
public Boolean getCopyTags() {
return this.copyTags;
}
/**
*
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is
* false.
*
*
* @param copyTags
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The
* default is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withCopyTags(Boolean copyTags) {
setCopyTags(copyTags);
return this;
}
/**
*
* True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is
* false.
*
*
* @return True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The
* default is false.
*/
public Boolean isCopyTags() {
return this.copyTags;
}
/**
*
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
* source AWS Region that contains the source DB snapshot to copy.
*
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
* Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy
* an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
* the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
* contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
* the same one where the CopyDBSnapshot action is called that contains this presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
* you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that
* contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the
* DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
* the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is
* called in the destination AWS Region, and the action contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied.
* This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
* are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using
* Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*
* @param preSignedUrl
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action
* in the source AWS Region that contains the source DB snapshot to copy.
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using
* the Amazon RDS API. You can specify the --source-region option instead of this parameter when
* you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be
* executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL
* request must contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS
* Region is the same one where the CopyDBSnapshot action is called that contains this presigned
* URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS
* Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a
* presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region.
* For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS
* Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB
* snapshot in the destination AWS Region. This is the same identifier for both the
* CopyDBSnapshot action that is called in the destination AWS Region, and the action contained
* in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
* example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating
* Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*/
public void setPreSignedUrl(String preSignedUrl) {
this.preSignedUrl = preSignedUrl;
}
/**
*
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
* source AWS Region that contains the source DB snapshot to copy.
*
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
* Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy
* an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
* the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
* contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
* the same one where the CopyDBSnapshot action is called that contains this presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
* you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that
* contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the
* DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
* the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is
* called in the destination AWS Region, and the action contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied.
* This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
* are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using
* Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*
* @return The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action
* in the source AWS Region that contains the source DB snapshot to copy.
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using
* the Amazon RDS API. You can specify the --source-region option instead of this parameter
* when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be
* executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL
* request must contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS
* Region is the same one where the CopyDBSnapshot action is called that contains this
* presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS
* Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a
* presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region.
* For this example, the DestinationRegion in the presigned URL must be set to the us-east-1
* AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB
* snapshot in the destination AWS Region. This is the same identifier for both the
* CopyDBSnapshot action that is called in the destination AWS Region, and the action contained
* in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
* example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating
* Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*/
public String getPreSignedUrl() {
return this.preSignedUrl;
}
/**
*
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the
* source AWS Region that contains the source DB snapshot to copy.
*
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the
* Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy
* an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in
* the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must
* contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is
* the same one where the CopyDBSnapshot action is called that contains this presigned URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then
* you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that
* contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the
* DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in
* the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is
* called in the destination AWS Region, and the action contained in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied.
* This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you
* are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using
* Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
*
*
* @param preSignedUrl
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action
* in the source AWS Region that contains the source DB snapshot to copy.
*
* You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using
* the Amazon RDS API. You can specify the --source-region option instead of this parameter when
* you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.
*
*
* The presigned URL must be a valid request for the CopyDBSnapshot API action that can be
* executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL
* request must contain the following parameter values:
*
*
* -
*
* DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS
* Region is the same one where the CopyDBSnapshot action is called that contains this presigned
* URL.
*
*
* For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS
* Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a
* presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region.
* For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS
* Region.
*
*
* -
*
* KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB
* snapshot in the destination AWS Region. This is the same identifier for both the
* CopyDBSnapshot action that is called in the destination AWS Region, and the action contained
* in the presigned URL.
*
*
* -
*
* SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For
* example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your
* SourceDBSnapshotIdentifier looks like the following example:
* arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
*
*
*
*
* To learn how to generate a Signature Version 4 signed request, see Authenticating
* Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing
* Process.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withPreSignedUrl(String preSignedUrl) {
setPreSignedUrl(preSignedUrl);
return this;
}
/**
*
* The name of an option group to associate with the copy of the snapshot.
*
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a
* nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL
* Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations.
*
*
* @param optionGroupName
* The name of an option group to associate with the copy of the snapshot.
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance
* uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or
* Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information,
* see Option Group Considerations.
*/
public void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
/**
*
* The name of an option group to associate with the copy of the snapshot.
*
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a
* nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL
* Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations.
*
*
* @return The name of an option group to associate with the copy of the snapshot.
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance
* uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or
* Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information,
* see Option Group Considerations.
*/
public String getOptionGroupName() {
return this.optionGroupName;
}
/**
*
* The name of an option group to associate with the copy of the snapshot.
*
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a
* nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL
* Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations.
*
*
* @param optionGroupName
* The name of an option group to associate with the copy of the snapshot.
*
* Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance
* uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or
* Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information,
* see Option Group Considerations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withOptionGroupName(String optionGroupName) {
setOptionGroupName(optionGroupName);
return this;
}
/**
* The region where the source snapshot is located.
*
* @param sourceRegion
* The region where the source snapshot is located.
*/
public void setSourceRegion(String sourceRegion) {
this.sourceRegion = sourceRegion;
}
/**
* The region where the source snapshot is located.
*
* @return The region where the source snapshot is located.
*/
public String getSourceRegion() {
return this.sourceRegion;
}
/**
* The region where the source snapshot is located.
*
* @param sourceRegion
* The region where the source snapshot is located.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBSnapshotRequest withSourceRegion(String sourceRegion) {
setSourceRegion(sourceRegion);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSourceDBSnapshotIdentifier() != null)
sb.append("SourceDBSnapshotIdentifier: ").append(getSourceDBSnapshotIdentifier()).append(",");
if (getTargetDBSnapshotIdentifier() != null)
sb.append("TargetDBSnapshotIdentifier: ").append(getTargetDBSnapshotIdentifier()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getCopyTags() != null)
sb.append("CopyTags: ").append(getCopyTags()).append(",");
if (getPreSignedUrl() != null)
sb.append("PreSignedUrl: ").append(getPreSignedUrl()).append(",");
if (getOptionGroupName() != null)
sb.append("OptionGroupName: ").append(getOptionGroupName()).append(",");
if (getSourceRegion() != null)
sb.append("SourceRegion: ").append(getSourceRegion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CopyDBSnapshotRequest == false)
return false;
CopyDBSnapshotRequest other = (CopyDBSnapshotRequest) obj;
if (other.getSourceDBSnapshotIdentifier() == null ^ this.getSourceDBSnapshotIdentifier() == null)
return false;
if (other.getSourceDBSnapshotIdentifier() != null && other.getSourceDBSnapshotIdentifier().equals(this.getSourceDBSnapshotIdentifier()) == false)
return false;
if (other.getTargetDBSnapshotIdentifier() == null ^ this.getTargetDBSnapshotIdentifier() == null)
return false;
if (other.getTargetDBSnapshotIdentifier() != null && other.getTargetDBSnapshotIdentifier().equals(this.getTargetDBSnapshotIdentifier()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getCopyTags() == null ^ this.getCopyTags() == null)
return false;
if (other.getCopyTags() != null && other.getCopyTags().equals(this.getCopyTags()) == false)
return false;
if (other.getPreSignedUrl() == null ^ this.getPreSignedUrl() == null)
return false;
if (other.getPreSignedUrl() != null && other.getPreSignedUrl().equals(this.getPreSignedUrl()) == false)
return false;
if (other.getOptionGroupName() == null ^ this.getOptionGroupName() == null)
return false;
if (other.getOptionGroupName() != null && other.getOptionGroupName().equals(this.getOptionGroupName()) == false)
return false;
if (other.getSourceRegion() == null ^ this.getSourceRegion() == null)
return false;
if (other.getSourceRegion() != null && other.getSourceRegion().equals(this.getSourceRegion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceDBSnapshotIdentifier() == null) ? 0 : getSourceDBSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getTargetDBSnapshotIdentifier() == null) ? 0 : getTargetDBSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getCopyTags() == null) ? 0 : getCopyTags().hashCode());
hashCode = prime * hashCode + ((getPreSignedUrl() == null) ? 0 : getPreSignedUrl().hashCode());
hashCode = prime * hashCode + ((getOptionGroupName() == null) ? 0 : getOptionGroupName().hashCode());
hashCode = prime * hashCode + ((getSourceRegion() == null) ? 0 : getSourceRegion().hashCode());
return hashCode;
}
@Override
public CopyDBSnapshotRequest clone() {
return (CopyDBSnapshotRequest) super.clone();
}
}