Struct aws_sdk_fsx::operation::copy_backup::builders::CopyBackupFluentBuilder
source · pub struct CopyBackupFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CopyBackup
.
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws
(Standard Regions), aws-cn
(China Regions), and aws-us-gov
(Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within the same Region.
You can use the SourceRegion
parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1
Region and want to copy a backup from the us-east-2
Region, you specify us-east-2
in the SourceRegion
parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.
Implementations§
source§impl CopyBackupFluentBuilder
impl CopyBackupFluentBuilder
sourcepub fn as_input(&self) -> &CopyBackupInputBuilder
pub fn as_input(&self) -> &CopyBackupInputBuilder
Access the CopyBackup as a reference.
sourcepub async fn send(
self
) -> Result<CopyBackupOutput, SdkError<CopyBackupError, HttpResponse>>
pub async fn send( self ) -> Result<CopyBackupOutput, SdkError<CopyBackupError, HttpResponse>>
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 customize(
self
) -> CustomizableOperation<CopyBackupOutput, CopyBackupError, Self>
pub fn customize( self ) -> CustomizableOperation<CopyBackupOutput, CopyBackupError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
sourcepub fn source_backup_id(self, input: impl Into<String>) -> Self
pub fn source_backup_id(self, input: impl Into<String>) -> Self
The ID of the source backup. Specifies the ID of the backup that's being copied.
sourcepub fn set_source_backup_id(self, input: Option<String>) -> Self
pub fn set_source_backup_id(self, input: Option<String>) -> Self
The ID of the source backup. Specifies the ID of the backup that's being copied.
sourcepub fn get_source_backup_id(&self) -> &Option<String>
pub fn get_source_backup_id(&self) -> &Option<String>
The ID of the source backup. Specifies the ID of the backup that's being copied.
sourcepub fn source_region(self, input: impl Into<String>) -> Self
pub fn source_region(self, input: impl Into<String>) -> Self
The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion
defaults to the Region where the request is sent from (in-Region copy).
sourcepub fn set_source_region(self, input: Option<String>) -> Self
pub fn set_source_region(self, input: Option<String>) -> Self
The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion
defaults to the Region where the request is sent from (in-Region copy).
sourcepub fn get_source_region(&self) -> &Option<String>
pub fn get_source_region(&self) -> &Option<String>
The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion
defaults to the Region where the request is sent from (in-Region copy).
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
-
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account. -
Amazon FSx for NetApp ONTAP
-
Amazon FSx for OpenZFS
-
Amazon FSx for Windows File Server
If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false
.
If you set CopyTags
to true
and the source backup has existing tags, you can use the Tags
parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags
parameter take precedence.
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false
.
If you set CopyTags
to true
and the source backup has existing tags, you can use the Tags
parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags
parameter take precedence.
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false
.
If you set CopyTags
to true
and the source backup has existing tags, you can use the Tags
parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags
parameter take precedence.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
A list of Tag
values, with a maximum of 50 elements.
A list of Tag
values, with a maximum of 50 elements.
A list of Tag
values, with a maximum of 50 elements.
Trait Implementations§
source§impl Clone for CopyBackupFluentBuilder
impl Clone for CopyBackupFluentBuilder
source§fn clone(&self) -> CopyBackupFluentBuilder
fn clone(&self) -> CopyBackupFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CopyBackupFluentBuilder
impl !RefUnwindSafe for CopyBackupFluentBuilder
impl Send for CopyBackupFluentBuilder
impl Sync for CopyBackupFluentBuilder
impl Unpin for CopyBackupFluentBuilder
impl !UnwindSafe for CopyBackupFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more