Recovers the saved resource identified by an Amazon Resource Name (ARN).
See also: AWS API Documentation
start-restore-job
--recovery-point-arn <value>
--metadata <value>
[--iam-role-arn <value>]
[--idempotency-token <value>]
[--resource-type <value>]
[--copy-source-tags-to-restored-resource | --no-copy-source-tags-to-restored-resource]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--recovery-point-arn
(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
(map)
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 byGetRecoveryPointRestoreMetadata
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:
- Metadata for Amazon Aurora
- Metadata for Amazon DocumentDB
- Metadata for CloudFormation
- Metadata for Amazon DynamoDB
- Metadata for Amazon EBS
- Metadata for Amazon EC2
- Metadata for Amazon EFS
- Metadata for Amazon FSx
- Metadata for Amazon Neptune
- Metadata for Amazon RDS
- Metadata for Amazon Redshift
- Metadata for Storage Gateway
- Metadata for Amazon S3
- Metadata for Amazon Timestream
- Metadata for virtual machines
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--iam-role-arn
(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
(string)
A customer-chosen string that you can use to distinguish between otherwise identical calls toStartRestoreJob
. Retrying a successful request with the same idempotency token results in a success message with no action taken.
--resource-type
(string)
Starts a job to restore a recovery point for one of the following resources:
Aurora
- Amazon AuroraDocumentDB
- Amazon DocumentDBCloudFormation
- CloudFormationDynamoDB
- Amazon DynamoDBEBS
- Amazon Elastic Block StoreEC2
- Amazon Elastic Compute CloudEFS
- Amazon Elastic File SystemFSx
- Amazon FSxNeptune
- Amazon NeptuneRDS
- Amazon Relational Database ServiceRedshift
- Amazon RedshiftStorage Gateway
- Storage GatewayS3
- Amazon Simple Storage ServiceTimestream
- Amazon TimestreamVirtualMachine
- Virtual machines
--copy-source-tags-to-restored-resource
| --no-copy-source-tags-to-restored-resource
(boolean)
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.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.