Struct aws_sdk_backup::operation::start_restore_job::StartRestoreJobInput

source · 
#[non_exhaustive]
pub struct StartRestoreJobInput {
    pub recovery_point_arn: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
    pub iam_role_arn: Option<String>,
    pub idempotency_token: Option<String>,
    pub resource_type: Option<String>,
    pub copy_source_tags_to_restored_resource: Option<bool>,
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§recovery_point_arn: 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.

§metadata: 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:

§iam_role_arn: 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.

§idempotency_token: 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.

§resource_type: 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

§copy_source_tags_to_restored_resource: Option<bool>

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.

Implementations§

source§

impl StartRestoreJobInput

source

pub fn recovery_point_arn(&self) -> Option<&str>

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

source

pub fn 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:

source

pub fn iam_role_arn(&self) -> Option<&str>

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.

source

pub fn idempotency_token(&self) -> Option<&str>

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.

source

pub fn resource_type(&self) -> Option<&str>

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

source

pub fn copy_source_tags_to_restored_resource(&self) -> Option<bool>

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.

source§

impl StartRestoreJobInput

source

pub fn builder() -> StartRestoreJobInputBuilder

Creates a new builder-style object to manufacture StartRestoreJobInput.

Trait Implementations§

source§

impl Clone for StartRestoreJobInput

source§

fn clone(&self) -> StartRestoreJobInput

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for StartRestoreJobInput

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq for StartRestoreJobInput

source§

fn eq(&self, other: &StartRestoreJobInput) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for StartRestoreJobInput

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more