pub struct StartBackupJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartBackupJob
.
Starts an on-demand backup job for the specified resource.
Implementations§
Source§impl StartBackupJobFluentBuilder
impl StartBackupJobFluentBuilder
Sourcepub fn as_input(&self) -> &StartBackupJobInputBuilder
pub fn as_input(&self) -> &StartBackupJobInputBuilder
Access the StartBackupJob as a reference.
Sourcepub async fn send(
self,
) -> Result<StartBackupJobOutput, SdkError<StartBackupJobError, HttpResponse>>
pub async fn send( self, ) -> Result<StartBackupJobOutput, SdkError<StartBackupJobError, 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<StartBackupJobOutput, StartBackupJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartBackupJobOutput, StartBackupJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn backup_vault_name(self, input: impl Into<String>) -> Self
pub fn backup_vault_name(self, input: impl Into<String>) -> Self
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
Sourcepub fn set_backup_vault_name(self, input: Option<String>) -> Self
pub fn set_backup_vault_name(self, input: Option<String>) -> Self
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
Sourcepub fn get_backup_vault_name(&self) -> &Option<String>
pub fn get_backup_vault_name(&self) -> &Option<String>
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
Sourcepub fn resource_arn(self, input: impl Into<String>) -> Self
pub fn resource_arn(self, input: impl Into<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Sourcepub fn set_resource_arn(self, input: Option<String>) -> Self
pub fn set_resource_arn(self, input: Option<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Sourcepub fn get_resource_arn(&self) -> &Option<String>
pub fn get_resource_arn(&self) -> &Option<String>
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Sourcepub fn iam_role_arn(self, input: impl Into<String>) -> Self
pub fn iam_role_arn(self, input: impl Into<String>) -> Self
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
Sourcepub fn set_iam_role_arn(self, input: Option<String>) -> Self
pub fn set_iam_role_arn(self, input: Option<String>) -> Self
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
Sourcepub fn get_iam_role_arn(&self) -> &Option<String>
pub fn get_iam_role_arn(&self) -> &Option<String>
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
Sourcepub fn idempotency_token(self, input: impl Into<String>) -> Self
pub fn idempotency_token(self, input: impl Into<String>) -> Self
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Sourcepub fn set_idempotency_token(self, input: Option<String>) -> Self
pub fn set_idempotency_token(self, input: Option<String>) -> Self
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Sourcepub fn get_idempotency_token(&self) -> &Option<String>
pub fn get_idempotency_token(&self) -> &Option<String>
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Sourcepub fn start_window_minutes(self, input: i64) -> Self
pub fn start_window_minutes(self, input: i64) -> Self
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in CREATED
status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING
) or until the job status changes to EXPIRED
(which is expected to occur when the start window time is over).
Sourcepub fn set_start_window_minutes(self, input: Option<i64>) -> Self
pub fn set_start_window_minutes(self, input: Option<i64>) -> Self
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in CREATED
status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING
) or until the job status changes to EXPIRED
(which is expected to occur when the start window time is over).
Sourcepub fn get_start_window_minutes(&self) -> &Option<i64>
pub fn get_start_window_minutes(&self) -> &Option<i64>
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in CREATED
status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING
) or until the job status changes to EXPIRED
(which is expected to occur when the start window time is over).
Sourcepub fn complete_window_minutes(self, input: i64) -> Self
pub fn complete_window_minutes(self, input: i64) -> Self
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes
, or if the backup started later than scheduled.
Like StartWindowMinutes
, this parameter has a maximum value of 100 years (52,560,000 minutes).
Sourcepub fn set_complete_window_minutes(self, input: Option<i64>) -> Self
pub fn set_complete_window_minutes(self, input: Option<i64>) -> Self
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes
, or if the backup started later than scheduled.
Like StartWindowMinutes
, this parameter has a maximum value of 100 years (52,560,000 minutes).
Sourcepub fn get_complete_window_minutes(&self) -> &Option<i64>
pub fn get_complete_window_minutes(&self) -> &Option<i64>
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes
, or if the backup started later than scheduled.
Like StartWindowMinutes
, this parameter has a maximum value of 100 years (52,560,000 minutes).
Sourcepub fn lifecycle(self, input: Lifecycle) -> Self
pub fn lifecycle(self, input: Lifecycle) -> Self
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
Sourcepub fn set_lifecycle(self, input: Option<Lifecycle>) -> Self
pub fn set_lifecycle(self, input: Option<Lifecycle>) -> Self
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
Sourcepub fn get_lifecycle(&self) -> &Option<Lifecycle>
pub fn get_lifecycle(&self) -> &Option<Lifecycle>
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
Adds a key-value pair to RecoveryPointTags
.
To override the contents of this collection use set_recovery_point_tags
.
The tags to assign to the resources.
The tags to assign to the resources.
The tags to assign to the resources.
Sourcepub fn backup_options(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn backup_options(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to BackupOptions
.
To override the contents of this collection use set_backup_options
.
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled"
to enable the WindowsVSS
backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled"
to create a regular backup. The WindowsVSS
option is not enabled by default.
Sourcepub fn set_backup_options(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_backup_options(self, input: Option<HashMap<String, String>>) -> Self
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled"
to enable the WindowsVSS
backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled"
to create a regular backup. The WindowsVSS
option is not enabled by default.
Sourcepub fn get_backup_options(&self) -> &Option<HashMap<String, String>>
pub fn get_backup_options(&self) -> &Option<HashMap<String, String>>
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled"
to enable the WindowsVSS
backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled"
to create a regular backup. The WindowsVSS
option is not enabled by default.
Sourcepub fn index(self, input: Index) -> Self
pub fn index(self, input: Index) -> Self
Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.
Resource types that support backup indexes include:
-
EBS
for Amazon Elastic Block Store -
S3
for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either ENABLED
or DISABLED
.
To create a backup index for an eligible ACTIVE
recovery point that does not yet have a backup index, set value to ENABLED
.
To delete a backup index, set value to DISABLED
.
Sourcepub fn set_index(self, input: Option<Index>) -> Self
pub fn set_index(self, input: Option<Index>) -> Self
Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.
Resource types that support backup indexes include:
-
EBS
for Amazon Elastic Block Store -
S3
for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either ENABLED
or DISABLED
.
To create a backup index for an eligible ACTIVE
recovery point that does not yet have a backup index, set value to ENABLED
.
To delete a backup index, set value to DISABLED
.
Sourcepub fn get_index(&self) -> &Option<Index>
pub fn get_index(&self) -> &Option<Index>
Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.
Resource types that support backup indexes include:
-
EBS
for Amazon Elastic Block Store -
S3
for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either ENABLED
or DISABLED
.
To create a backup index for an eligible ACTIVE
recovery point that does not yet have a backup index, set value to ENABLED
.
To delete a backup index, set value to DISABLED
.
Trait Implementations§
Source§impl Clone for StartBackupJobFluentBuilder
impl Clone for StartBackupJobFluentBuilder
Source§fn clone(&self) -> StartBackupJobFluentBuilder
fn clone(&self) -> StartBackupJobFluentBuilder
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 StartBackupJobFluentBuilder
impl !RefUnwindSafe for StartBackupJobFluentBuilder
impl Send for StartBackupJobFluentBuilder
impl Sync for StartBackupJobFluentBuilder
impl Unpin for StartBackupJobFluentBuilder
impl !UnwindSafe for StartBackupJobFluentBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);