com.amazonaws.services.docdb.model.CopyDBClusterSnapshotRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-docdb Show documentation
/*
* Copyright 2019-2024 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.docdb.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input to CopyDBClusterSnapshot.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CopyDBClusterSnapshotRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster
* snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
*
*/
private String sourceDBClusterSnapshotIdentifier;
/**
*
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case
* sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
*
*/
private String targetDBClusterSnapshotIdentifier;
/**
*
* The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value for
* KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for
* KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source
* cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must
* specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS
* key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption
* keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys
* from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error
* is returned.
*
*/
private String kmsKeyId;
/**
*
* The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action
* in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the
* PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
*
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
* --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying
* SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be
* executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be
* executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned
* URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services
* Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services
* Region, then your SourceDBClusterSnapshotIdentifier looks something like the following:
* arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This
* parameter isn't case sensitive.
*
*
*
*/
private String preSignedUrl;
/**
*
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and
* otherwise false. The default is false.
*
*/
private Boolean copyTags;
/**
*
* The tags to be assigned to the cluster snapshot.
*
*/
private java.util.List tags;
/** The region where the source instance is located. */
private String sourceRegion;
/**
*
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster
* snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
*
*
* @param sourceDBClusterSnapshotIdentifier
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster
* snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
*/
public void setSourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier) {
this.sourceDBClusterSnapshotIdentifier = sourceDBClusterSnapshotIdentifier;
}
/**
*
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster
* snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
*
*
* @return The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid
* cluster snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
*/
public String getSourceDBClusterSnapshotIdentifier() {
return this.sourceDBClusterSnapshotIdentifier;
}
/**
*
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster
* snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
*
*
* @param sourceDBClusterSnapshotIdentifier
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
*
* Constraints:
*
*
* -
*
* Must specify a valid system snapshot in the available state.
*
*
* -
*
* If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot
* identifier.
*
*
* -
*
* If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster
* snapshot ARN.
*
*
*
*
* Example: my-cluster-snapshot1
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withSourceDBClusterSnapshotIdentifier(String sourceDBClusterSnapshotIdentifier) {
setSourceDBClusterSnapshotIdentifier(sourceDBClusterSnapshotIdentifier);
return this;
}
/**
*
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case
* sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
*
*
* @param targetDBClusterSnapshotIdentifier
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is
* not case sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
*/
public void setTargetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier) {
this.targetDBClusterSnapshotIdentifier = targetDBClusterSnapshotIdentifier;
}
/**
*
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case
* sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
*
*
* @return The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is
* not case sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
*/
public String getTargetDBClusterSnapshotIdentifier() {
return this.targetDBClusterSnapshotIdentifier;
}
/**
*
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case
* sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
*
*
* @param targetDBClusterSnapshotIdentifier
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is
* not case sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster-snapshot2
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withTargetDBClusterSnapshotIdentifier(String targetDBClusterSnapshotIdentifier) {
setTargetDBClusterSnapshotIdentifier(targetDBClusterSnapshotIdentifier);
return this;
}
/**
*
* The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value for
* KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for
* KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source
* cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must
* specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS
* key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption
* keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys
* from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error
* is returned.
*
*
* @param kmsKeyId
* The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value
* for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value
* for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the
* source cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then
* you must specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to
* the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region.
* KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't
* use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter,
* an error is returned.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value for
* KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for
* KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source
* cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must
* specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS
* key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption
* keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys
* from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error
* is returned.
*
*
* @return The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value
* for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value
* for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as
* the source cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then
* you must specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to
* the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination
* Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and
* you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter,
* an error is returned.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value for
* KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for
* KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source
* cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must
* specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS
* key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption
* keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys
* from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error
* is returned.
*
*
* @param kmsKeyId
* The KMS key ID for an encrypted cluster 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 cluster snapshot from your Amazon Web Services account, you can specify a value
* for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value
* for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the
* source cluster snapshot.
*
*
* If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then
* you must specify a value for KmsKeyId.
*
*
* To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to
* the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region.
* KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't
* use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.
*
*
* If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter,
* an error is returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action
* in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the
* PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
*
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
* --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying
* SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be
* executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be
* executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned
* URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services
* Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services
* Region, then your SourceDBClusterSnapshotIdentifier looks something like the following:
* arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This
* parameter isn't case sensitive.
*
*
*
*
* @param preSignedUrl
* The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API
* action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use
* the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services
* Region.
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
* --source-region for the CLI) instead of specifying PreSignedUrl manually.
* Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the
* operation that can be executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can
* be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The
* presigned URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to
* be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
* Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon
* Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the
* following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be
* created. This parameter isn't case sensitive.
*
*
*/
public void setPreSignedUrl(String preSignedUrl) {
this.preSignedUrl = preSignedUrl;
}
/**
*
* The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action
* in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the
* PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
*
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
* --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying
* SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be
* executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be
* executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned
* URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services
* Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services
* Region, then your SourceDBClusterSnapshotIdentifier looks something like the following:
* arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This
* parameter isn't case sensitive.
*
*
*
*
* @return The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API
* action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use
* the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services
* Region.
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
* (or --source-region for the CLI) instead of specifying PreSignedUrl manually.
* Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the
* operation that can be executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can
* be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The
* presigned URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to
* be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
* Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon
* Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the
* following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be
* created. This parameter isn't case sensitive.
*
*
*/
public String getPreSignedUrl() {
return this.preSignedUrl;
}
/**
*
* The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action
* in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the
* PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
*
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
* --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying
* SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be
* executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be
* executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned
* URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be
* copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services
* Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services
* Region, then your SourceDBClusterSnapshotIdentifier looks something like the following:
* arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This
* parameter isn't case sensitive.
*
*
*
*
* @param preSignedUrl
* The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API
* action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use
* the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services
* Region.
*
* If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
* --source-region for the CLI) instead of specifying PreSignedUrl manually.
* Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the
* operation that can be executed in the source Amazon Web Services Region.
*
*
* The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can
* be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The
* presigned URL request must contain the following parameter values:
*
*
* -
*
* SourceRegion - The ID of the region that contains the snapshot to be copied.
*
*
* -
*
* SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to
* be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
* Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon
* Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the
* following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
*
*
* -
*
* TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be
* created. This parameter isn't case sensitive.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withPreSignedUrl(String preSignedUrl) {
setPreSignedUrl(preSignedUrl);
return this;
}
/**
*
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and
* otherwise false. The default is false.
*
*
* @param copyTags
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot,
* and otherwise false. The default is false.
*/
public void setCopyTags(Boolean copyTags) {
this.copyTags = copyTags;
}
/**
*
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and
* otherwise false. The default is false.
*
*
* @return Set to true to copy all tags from the source cluster snapshot to the target cluster
* snapshot, and otherwise false. The default is false.
*/
public Boolean getCopyTags() {
return this.copyTags;
}
/**
*
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and
* otherwise false. The default is false.
*
*
* @param copyTags
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot,
* and otherwise false. The default is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withCopyTags(Boolean copyTags) {
setCopyTags(copyTags);
return this;
}
/**
*
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and
* otherwise false. The default is false.
*
*
* @return Set to true to copy all tags from the source cluster snapshot to the target cluster
* snapshot, and otherwise false. The default is false.
*/
public Boolean isCopyTags() {
return this.copyTags;
}
/**
*
* The tags to be assigned to the cluster snapshot.
*
*
* @return The tags to be assigned to the cluster snapshot.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The tags to be assigned to the cluster snapshot.
*
*
* @param tags
* The tags to be assigned to the cluster snapshot.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The tags to be assigned to the cluster snapshot.
*
*
* 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
* The tags to be assigned to the cluster snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The tags to be assigned to the cluster snapshot.
*
*
* @param tags
* The tags to be assigned to the cluster snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* The region where the source instance is located.
*
* @param sourceRegion
* The region where the source instance is located.
*/
public void setSourceRegion(String sourceRegion) {
this.sourceRegion = sourceRegion;
}
/**
* The region where the source instance is located.
*
* @return The region where the source instance is located.
*/
public String getSourceRegion() {
return this.sourceRegion;
}
/**
* The region where the source instance is located.
*
* @param sourceRegion
* The region where the source instance is located.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyDBClusterSnapshotRequest withSourceRegion(String sourceRegion) {
setSourceRegion(sourceRegion);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSourceDBClusterSnapshotIdentifier() != null)
sb.append("SourceDBClusterSnapshotIdentifier: ").append(getSourceDBClusterSnapshotIdentifier()).append(",");
if (getTargetDBClusterSnapshotIdentifier() != null)
sb.append("TargetDBClusterSnapshotIdentifier: ").append(getTargetDBClusterSnapshotIdentifier()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getPreSignedUrl() != null)
sb.append("PreSignedUrl: ").append(getPreSignedUrl()).append(",");
if (getCopyTags() != null)
sb.append("CopyTags: ").append(getCopyTags()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).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 CopyDBClusterSnapshotRequest == false)
return false;
CopyDBClusterSnapshotRequest other = (CopyDBClusterSnapshotRequest) obj;
if (other.getSourceDBClusterSnapshotIdentifier() == null ^ this.getSourceDBClusterSnapshotIdentifier() == null)
return false;
if (other.getSourceDBClusterSnapshotIdentifier() != null
&& other.getSourceDBClusterSnapshotIdentifier().equals(this.getSourceDBClusterSnapshotIdentifier()) == false)
return false;
if (other.getTargetDBClusterSnapshotIdentifier() == null ^ this.getTargetDBClusterSnapshotIdentifier() == null)
return false;
if (other.getTargetDBClusterSnapshotIdentifier() != null
&& other.getTargetDBClusterSnapshotIdentifier().equals(this.getTargetDBClusterSnapshotIdentifier()) == 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.getPreSignedUrl() == null ^ this.getPreSignedUrl() == null)
return false;
if (other.getPreSignedUrl() != null && other.getPreSignedUrl().equals(this.getPreSignedUrl()) == 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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == 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 + ((getSourceDBClusterSnapshotIdentifier() == null) ? 0 : getSourceDBClusterSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getTargetDBClusterSnapshotIdentifier() == null) ? 0 : getTargetDBClusterSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getPreSignedUrl() == null) ? 0 : getPreSignedUrl().hashCode());
hashCode = prime * hashCode + ((getCopyTags() == null) ? 0 : getCopyTags().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getSourceRegion() == null) ? 0 : getSourceRegion().hashCode());
return hashCode;
}
@Override
public CopyDBClusterSnapshotRequest clone() {
return (CopyDBClusterSnapshotRequest) super.clone();
}
}