1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_restore_job::_start_restore_job_output::StartRestoreJobOutputBuilder;
pub use crate::operation::start_restore_job::_start_restore_job_input::StartRestoreJobInputBuilder;
impl StartRestoreJobInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::start_restore_job::StartRestoreJobOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_restore_job::StartRestoreJobError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.start_restore_job();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `StartRestoreJob`.
///
/// <p>Recovers the saved resource identified by an Amazon Resource Name (ARN).</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartRestoreJobFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_restore_job::builders::StartRestoreJobInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::start_restore_job::StartRestoreJobOutput,
crate::operation::start_restore_job::StartRestoreJobError,
> for StartRestoreJobFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::start_restore_job::StartRestoreJobOutput,
crate::operation::start_restore_job::StartRestoreJobError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl StartRestoreJobFluentBuilder {
/// Creates a new `StartRestoreJob`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the StartRestoreJob as a reference.
pub fn as_input(&self) -> &crate::operation::start_restore_job::builders::StartRestoreJobInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::start_restore_job::StartRestoreJobOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_restore_job::StartRestoreJobError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::start_restore_job::StartRestoreJob::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::start_restore_job::StartRestoreJob::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::start_restore_job::StartRestoreJobOutput,
crate::operation::start_restore_job::StartRestoreJobError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
pub fn recovery_point_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.recovery_point_arn(input.into());
self
}
/// <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
pub fn set_recovery_point_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_recovery_point_arn(input);
self
}
/// <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
pub fn get_recovery_point_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_recovery_point_arn()
}
/// Adds a key-value pair to `Metadata`.
///
/// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
///
/// <p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p>
/// <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p>
/// <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p>
/// <ul>
/// <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li>
/// <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li>
/// <li> <p> <code>KmsKeyId</code>: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.</p> </li>
/// <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li>
/// <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li>
/// <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li>
/// <li> <p> <code>ItemsToRestore</code>: An array of one to five strings where each string is a file path. Use <code>ItemsToRestore</code> to restore specific files or directories rather than the entire file system. This parameter is optional. For example, <code>"itemsToRestore":"[\"/my.test\"]"</code>.</p> </li>
/// </ul>
pub fn metadata(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.metadata(k.into(), v.into());
self
}
/// <p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p>
/// <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p>
/// <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p>
/// <ul>
/// <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li>
/// <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li>
/// <li> <p> <code>KmsKeyId</code>: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.</p> </li>
/// <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li>
/// <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li>
/// <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li>
/// <li> <p> <code>ItemsToRestore</code>: An array of one to five strings where each string is a file path. Use <code>ItemsToRestore</code> to restore specific files or directories rather than the entire file system. This parameter is optional. For example, <code>"itemsToRestore":"[\"/my.test\"]"</code>.</p> </li>
/// </ul>
pub fn set_metadata(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.inner = self.inner.set_metadata(input);
self
}
/// <p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p>
/// <p> You can get configuration metadata about a resource at the time it was backed up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p>
/// <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p>
/// <ul>
/// <li> <p> <code>file-system-id</code>: The ID of the Amazon EFS file system that is backed up by Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li>
/// <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li>
/// <li> <p> <code>KmsKeyId</code>: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.</p> </li>
/// <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li>
/// <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li>
/// <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li>
/// <li> <p> <code>ItemsToRestore</code>: An array of one to five strings where each string is a file path. Use <code>ItemsToRestore</code> to restore specific files or directories rather than the entire file system. This parameter is optional. For example, <code>"itemsToRestore":"[\"/my.test\"]"</code>.</p> </li>
/// </ul>
pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.inner.get_metadata()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
pub fn iam_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.iam_role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
pub fn set_iam_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_iam_role_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
pub fn get_iam_role_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_iam_role_arn()
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartRestoreJob</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn idempotency_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.idempotency_token(input.into());
self
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartRestoreJob</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn set_idempotency_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_idempotency_token(input);
self
}
/// <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartRestoreJob</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>
pub fn get_idempotency_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_idempotency_token()
}
/// <p>Starts a job to restore a recovery point for one of the following resources:</p>
/// <ul>
/// <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li>
/// <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li>
/// <li> <p> <code>CloudFormation</code> for CloudFormation</p> </li>
/// <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li>
/// <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li>
/// <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li>
/// <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li>
/// <li> <p> <code>FSx</code> for Amazon FSx</p> </li>
/// <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li>
/// <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li>
/// <li> <p> <code>Redshift</code> for Amazon Redshift</p> </li>
/// <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li>
/// <li> <p> <code>S3</code> for Amazon S3</p> </li>
/// <li> <p> <code>Timestream</code> for Amazon Timestream</p> </li>
/// <li> <p> <code>VirtualMachine</code> for virtual machines</p> </li>
/// </ul>
pub fn resource_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.resource_type(input.into());
self
}
/// <p>Starts a job to restore a recovery point for one of the following resources:</p>
/// <ul>
/// <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li>
/// <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li>
/// <li> <p> <code>CloudFormation</code> for CloudFormation</p> </li>
/// <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li>
/// <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li>
/// <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li>
/// <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li>
/// <li> <p> <code>FSx</code> for Amazon FSx</p> </li>
/// <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li>
/// <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li>
/// <li> <p> <code>Redshift</code> for Amazon Redshift</p> </li>
/// <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li>
/// <li> <p> <code>S3</code> for Amazon S3</p> </li>
/// <li> <p> <code>Timestream</code> for Amazon Timestream</p> </li>
/// <li> <p> <code>VirtualMachine</code> for virtual machines</p> </li>
/// </ul>
pub fn set_resource_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_resource_type(input);
self
}
/// <p>Starts a job to restore a recovery point for one of the following resources:</p>
/// <ul>
/// <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li>
/// <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li>
/// <li> <p> <code>CloudFormation</code> for CloudFormation</p> </li>
/// <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li>
/// <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li>
/// <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li>
/// <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li>
/// <li> <p> <code>FSx</code> for Amazon FSx</p> </li>
/// <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li>
/// <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li>
/// <li> <p> <code>Redshift</code> for Amazon Redshift</p> </li>
/// <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li>
/// <li> <p> <code>S3</code> for Amazon S3</p> </li>
/// <li> <p> <code>Timestream</code> for Amazon Timestream</p> </li>
/// <li> <p> <code>VirtualMachine</code> for virtual machines</p> </li>
/// </ul>
pub fn get_resource_type(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_resource_type()
}
/// <p>This is an optional parameter. If this equals <code>True</code>, tags included in the backup will be copied to the restored resource.</p>
/// <p>This can only be applied to backups created through Backup.</p>
pub fn copy_source_tags_to_restored_resource(mut self, input: bool) -> Self {
self.inner = self.inner.copy_source_tags_to_restored_resource(input);
self
}
/// <p>This is an optional parameter. If this equals <code>True</code>, tags included in the backup will be copied to the restored resource.</p>
/// <p>This can only be applied to backups created through Backup.</p>
pub fn set_copy_source_tags_to_restored_resource(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_copy_source_tags_to_restored_resource(input);
self
}
/// <p>This is an optional parameter. If this equals <code>True</code>, tags included in the backup will be copied to the restored resource.</p>
/// <p>This can only be applied to backups created through Backup.</p>
pub fn get_copy_source_tags_to_restored_resource(&self) -> &::std::option::Option<bool> {
self.inner.get_copy_source_tags_to_restored_resource()
}
}