Struct aws_sdk_docdb::client::fluent_builders::CopyDBClusterSnapshot
source · [−]pub struct CopyDBClusterSnapshot { /* private fields */ }Expand description
Fluent builder constructing a request to CopyDBClusterSnapshot.
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
Implementations
sourceimpl CopyDBClusterSnapshot
impl CopyDBClusterSnapshot
sourcepub async fn send(
self
) -> Result<CopyDbClusterSnapshotOutput, SdkError<CopyDBClusterSnapshotError>>
pub async fn send(
self
) -> Result<CopyDbClusterSnapshotOutput, SdkError<CopyDBClusterSnapshotError>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn source_db_cluster_snapshot_identifier(
self,
input: impl Into<String>
) -> Self
pub fn source_db_cluster_snapshot_identifier(
self,
input: impl Into<String>
) -> Self
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 Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
sourcepub fn set_source_db_cluster_snapshot_identifier(
self,
input: Option<String>
) -> Self
pub fn set_source_db_cluster_snapshot_identifier(
self,
input: Option<String>
) -> Self
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 Region as the copy, specify a valid snapshot identifier.
-
If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
sourcepub fn target_db_cluster_snapshot_identifier(
self,
input: impl Into<String>
) -> Self
pub fn target_db_cluster_snapshot_identifier(
self,
input: impl Into<String>
) -> Self
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
sourcepub fn set_target_db_cluster_snapshot_identifier(
self,
input: Option<String>
) -> Self
pub fn set_target_db_cluster_snapshot_identifier(
self,
input: Option<String>
) -> Self
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
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
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 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 account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another 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 Region that they are created in, and you can't use encryption keys from one Region in another Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
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 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 account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another 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 Region that they are created in, and you can't use encryption keys from one Region in another Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
sourcepub fn pre_signed_url(self, input: impl Into<String>) -> Self
pub fn pre_signed_url(self, input: impl Into<String>) -> Self
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another 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 Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source 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 Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then yourSourceDBClusterSnapshotIdentifierlooks 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.
sourcepub fn set_pre_signed_url(self, input: Option<String>) -> Self
pub fn set_pre_signed_url(self, input: Option<String>) -> Self
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another 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 Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source 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 Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then yourSourceDBClusterSnapshotIdentifierlooks 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.
Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.
Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.
Appends an item to Tags.
To override the contents of this collection use set_tags.
The tags to be assigned to the cluster snapshot.
The tags to be assigned to the cluster snapshot.
Trait Implementations
sourceimpl Clone for CopyDBClusterSnapshot
impl Clone for CopyDBClusterSnapshot
sourcefn clone(&self) -> CopyDBClusterSnapshot
fn clone(&self) -> CopyDBClusterSnapshot
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CopyDBClusterSnapshot
impl Send for CopyDBClusterSnapshot
impl Sync for CopyDBClusterSnapshot
impl Unpin for CopyDBClusterSnapshot
impl !UnwindSafe for CopyDBClusterSnapshot
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more