aws_sdk_ec2/operation/create_restore_image_task/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_restore_image_task::_create_restore_image_task_output::CreateRestoreImageTaskOutputBuilder;
3
4pub use crate::operation::create_restore_image_task::_create_restore_image_task_input::CreateRestoreImageTaskInputBuilder;
5
6impl crate::operation::create_restore_image_task::builders::CreateRestoreImageTaskInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_restore_image_task::CreateRestoreImageTaskOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_restore_image_task::CreateRestoreImageTaskError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_restore_image_task();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateRestoreImageTask`.
24///
25/// <p>Starts a task that restores an AMI from an Amazon S3 object that was previously created by using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
26/// <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
27/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct CreateRestoreImageTaskFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::create_restore_image_task::builders::CreateRestoreImageTaskInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::create_restore_image_task::CreateRestoreImageTaskOutput,
37        crate::operation::create_restore_image_task::CreateRestoreImageTaskError,
38    > for CreateRestoreImageTaskFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::create_restore_image_task::CreateRestoreImageTaskOutput,
46            crate::operation::create_restore_image_task::CreateRestoreImageTaskError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl CreateRestoreImageTaskFluentBuilder {
53    /// Creates a new `CreateRestoreImageTaskFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the CreateRestoreImageTask as a reference.
62    pub fn as_input(&self) -> &crate::operation::create_restore_image_task::builders::CreateRestoreImageTaskInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::create_restore_image_task::CreateRestoreImageTaskOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::create_restore_image_task::CreateRestoreImageTaskError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::create_restore_image_task::CreateRestoreImageTask::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::create_restore_image_task::CreateRestoreImageTask::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::create_restore_image_task::CreateRestoreImageTaskOutput,
99        crate::operation::create_restore_image_task::CreateRestoreImageTaskError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The name of the Amazon S3 bucket that contains the stored AMI object.</p>
114    pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.bucket(input.into());
116        self
117    }
118    /// <p>The name of the Amazon S3 bucket that contains the stored AMI object.</p>
119    pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_bucket(input);
121        self
122    }
123    /// <p>The name of the Amazon S3 bucket that contains the stored AMI object.</p>
124    pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_bucket()
126    }
127    /// <p>The name of the stored AMI object in the bucket.</p>
128    pub fn object_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.object_key(input.into());
130        self
131    }
132    /// <p>The name of the stored AMI object in the bucket.</p>
133    pub fn set_object_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_object_key(input);
135        self
136    }
137    /// <p>The name of the stored AMI object in the bucket.</p>
138    pub fn get_object_key(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_object_key()
140    }
141    /// <p>The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.</p>
142    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.name(input.into());
144        self
145    }
146    /// <p>The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.</p>
147    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_name(input);
149        self
150    }
151    /// <p>The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.</p>
152    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_name()
154    }
155    ///
156    /// Appends an item to `TagSpecifications`.
157    ///
158    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
159    ///
160    /// <p>The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.</p>
161    /// <ul>
162    /// <li>
163    /// <p>To tag the AMI, the value for <code>ResourceType</code> must be <code>image</code>.</p></li>
164    /// <li>
165    /// <p>To tag the snapshots, the value for <code>ResourceType</code> must be <code>snapshot</code>. The same tag is applied to all of the snapshots that are created.</p></li>
166    /// </ul>
167    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
168        self.inner = self.inner.tag_specifications(input);
169        self
170    }
171    /// <p>The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.</p>
172    /// <ul>
173    /// <li>
174    /// <p>To tag the AMI, the value for <code>ResourceType</code> must be <code>image</code>.</p></li>
175    /// <li>
176    /// <p>To tag the snapshots, the value for <code>ResourceType</code> must be <code>snapshot</code>. The same tag is applied to all of the snapshots that are created.</p></li>
177    /// </ul>
178    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
179        self.inner = self.inner.set_tag_specifications(input);
180        self
181    }
182    /// <p>The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.</p>
183    /// <ul>
184    /// <li>
185    /// <p>To tag the AMI, the value for <code>ResourceType</code> must be <code>image</code>.</p></li>
186    /// <li>
187    /// <p>To tag the snapshots, the value for <code>ResourceType</code> must be <code>snapshot</code>. The same tag is applied to all of the snapshots that are created.</p></li>
188    /// </ul>
189    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
190        self.inner.get_tag_specifications()
191    }
192    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
193    pub fn dry_run(mut self, input: bool) -> Self {
194        self.inner = self.inner.dry_run(input);
195        self
196    }
197    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
198    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
199        self.inner = self.inner.set_dry_run(input);
200        self
201    }
202    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
203    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
204        self.inner.get_dry_run()
205    }
206}