pub struct StartRestoreJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartRestoreJob
.
Recovers the saved resource identified by an Amazon Resource Name (ARN).
Implementations§
Source§impl StartRestoreJobFluentBuilder
impl StartRestoreJobFluentBuilder
Sourcepub fn as_input(&self) -> &StartRestoreJobInputBuilder
pub fn as_input(&self) -> &StartRestoreJobInputBuilder
Access the StartRestoreJob as a reference.
Sourcepub async fn send(
self,
) -> Result<StartRestoreJobOutput, SdkError<StartRestoreJobError, HttpResponse>>
pub async fn send( self, ) -> Result<StartRestoreJobOutput, SdkError<StartRestoreJobError, 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<StartRestoreJobOutput, StartRestoreJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartRestoreJobOutput, StartRestoreJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn recovery_point_arn(self, input: impl Into<String>) -> Self
pub fn recovery_point_arn(self, input: impl Into<String>) -> Self
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
Sourcepub fn set_recovery_point_arn(self, input: Option<String>) -> Self
pub fn set_recovery_point_arn(self, input: Option<String>) -> Self
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
Sourcepub fn get_recovery_point_arn(&self) -> &Option<String>
pub fn get_recovery_point_arn(&self) -> &Option<String>
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
Sourcepub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Metadata
.
To override the contents of this collection use set_metadata
.
A set of metadata key-value pairs.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata
. However, values in addition to those provided by GetRecoveryPointRestoreMetadata
might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
For more information about the metadata for each resource, see the following:
Sourcepub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
A set of metadata key-value pairs.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata
. However, values in addition to those provided by GetRecoveryPointRestoreMetadata
might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
For more information about the metadata for each resource, see the following:
Sourcepub fn get_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_metadata(&self) -> &Option<HashMap<String, String>>
A set of metadata key-value pairs.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata
. However, values in addition to those provided by GetRecoveryPointRestoreMetadata
might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
For more information about the metadata for each resource, see the following:
Sourcepub fn iam_role_arn(self, input: impl Into<String>) -> Self
pub fn iam_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; 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
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; 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>
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; 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 StartRestoreJob
. 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 StartRestoreJob
. 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 StartRestoreJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Sourcepub fn resource_type(self, input: impl Into<String>) -> Self
pub fn resource_type(self, input: impl Into<String>) -> Self
Starts a job to restore a recovery point for one of the following resources:
-
Aurora
- Amazon Aurora -
DocumentDB
- Amazon DocumentDB -
CloudFormation
- CloudFormation -
DynamoDB
- Amazon DynamoDB -
EBS
- Amazon Elastic Block Store -
EC2
- Amazon Elastic Compute Cloud -
EFS
- Amazon Elastic File System -
FSx
- Amazon FSx -
Neptune
- Amazon Neptune -
RDS
- Amazon Relational Database Service -
Redshift
- Amazon Redshift -
Storage Gateway
- Storage Gateway -
S3
- Amazon Simple Storage Service -
Timestream
- Amazon Timestream -
VirtualMachine
- Virtual machines
Sourcepub fn set_resource_type(self, input: Option<String>) -> Self
pub fn set_resource_type(self, input: Option<String>) -> Self
Starts a job to restore a recovery point for one of the following resources:
-
Aurora
- Amazon Aurora -
DocumentDB
- Amazon DocumentDB -
CloudFormation
- CloudFormation -
DynamoDB
- Amazon DynamoDB -
EBS
- Amazon Elastic Block Store -
EC2
- Amazon Elastic Compute Cloud -
EFS
- Amazon Elastic File System -
FSx
- Amazon FSx -
Neptune
- Amazon Neptune -
RDS
- Amazon Relational Database Service -
Redshift
- Amazon Redshift -
Storage Gateway
- Storage Gateway -
S3
- Amazon Simple Storage Service -
Timestream
- Amazon Timestream -
VirtualMachine
- Virtual machines
Sourcepub fn get_resource_type(&self) -> &Option<String>
pub fn get_resource_type(&self) -> &Option<String>
Starts a job to restore a recovery point for one of the following resources:
-
Aurora
- Amazon Aurora -
DocumentDB
- Amazon DocumentDB -
CloudFormation
- CloudFormation -
DynamoDB
- Amazon DynamoDB -
EBS
- Amazon Elastic Block Store -
EC2
- Amazon Elastic Compute Cloud -
EFS
- Amazon Elastic File System -
FSx
- Amazon FSx -
Neptune
- Amazon Neptune -
RDS
- Amazon Relational Database Service -
Redshift
- Amazon Redshift -
Storage Gateway
- Storage Gateway -
S3
- Amazon Simple Storage Service -
Timestream
- Amazon Timestream -
VirtualMachine
- Virtual machines
This is an optional parameter. If this equals True
, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
This is an optional parameter. If this equals True
, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
This is an optional parameter. If this equals True
, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
Trait Implementations§
Source§impl Clone for StartRestoreJobFluentBuilder
impl Clone for StartRestoreJobFluentBuilder
Source§fn clone(&self) -> StartRestoreJobFluentBuilder
fn clone(&self) -> StartRestoreJobFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartRestoreJobFluentBuilder
impl !RefUnwindSafe for StartRestoreJobFluentBuilder
impl Send for StartRestoreJobFluentBuilder
impl Sync for StartRestoreJobFluentBuilder
impl Unpin for StartRestoreJobFluentBuilder
impl !UnwindSafe for StartRestoreJobFluentBuilder
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);