aws_sdk_ec2/operation/create_fpga_image/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_fpga_image::_create_fpga_image_output::CreateFpgaImageOutputBuilder;
3
4pub use crate::operation::create_fpga_image::_create_fpga_image_input::CreateFpgaImageInputBuilder;
5
6impl crate::operation::create_fpga_image::builders::CreateFpgaImageInputBuilder {
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_fpga_image::CreateFpgaImageOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_fpga_image::CreateFpgaImageError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_fpga_image();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateFpgaImage`.
24///
25/// <p>Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).</p>
26/// <p>The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs.</p>
27/// <p>An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the <a href="https://github.com/aws/aws-fpga/">Amazon Web Services FPGA Hardware Development Kit</a>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct CreateFpgaImageFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::create_fpga_image::builders::CreateFpgaImageInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::create_fpga_image::CreateFpgaImageOutput,
37        crate::operation::create_fpga_image::CreateFpgaImageError,
38    > for CreateFpgaImageFluentBuilder
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_fpga_image::CreateFpgaImageOutput,
46            crate::operation::create_fpga_image::CreateFpgaImageError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl CreateFpgaImageFluentBuilder {
53    /// Creates a new `CreateFpgaImageFluentBuilder`.
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 CreateFpgaImage as a reference.
62    pub fn as_input(&self) -> &crate::operation::create_fpga_image::builders::CreateFpgaImageInputBuilder {
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_fpga_image::CreateFpgaImageOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::create_fpga_image::CreateFpgaImageError,
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_fpga_image::CreateFpgaImage::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::create_fpga_image::CreateFpgaImage::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_fpga_image::CreateFpgaImageOutput,
99        crate::operation::create_fpga_image::CreateFpgaImageError,
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>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>
114    pub fn dry_run(mut self, input: bool) -> Self {
115        self.inner = self.inner.dry_run(input);
116        self
117    }
118    /// <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>
119    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
120        self.inner = self.inner.set_dry_run(input);
121        self
122    }
123    /// <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>
124    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
125        self.inner.get_dry_run()
126    }
127    /// <p>The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.</p>
128    pub fn input_storage_location(mut self, input: crate::types::StorageLocation) -> Self {
129        self.inner = self.inner.input_storage_location(input);
130        self
131    }
132    /// <p>The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.</p>
133    pub fn set_input_storage_location(mut self, input: ::std::option::Option<crate::types::StorageLocation>) -> Self {
134        self.inner = self.inner.set_input_storage_location(input);
135        self
136    }
137    /// <p>The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.</p>
138    pub fn get_input_storage_location(&self) -> &::std::option::Option<crate::types::StorageLocation> {
139        self.inner.get_input_storage_location()
140    }
141    /// <p>The location in Amazon S3 for the output logs.</p>
142    pub fn logs_storage_location(mut self, input: crate::types::StorageLocation) -> Self {
143        self.inner = self.inner.logs_storage_location(input);
144        self
145    }
146    /// <p>The location in Amazon S3 for the output logs.</p>
147    pub fn set_logs_storage_location(mut self, input: ::std::option::Option<crate::types::StorageLocation>) -> Self {
148        self.inner = self.inner.set_logs_storage_location(input);
149        self
150    }
151    /// <p>The location in Amazon S3 for the output logs.</p>
152    pub fn get_logs_storage_location(&self) -> &::std::option::Option<crate::types::StorageLocation> {
153        self.inner.get_logs_storage_location()
154    }
155    /// <p>A description for the AFI.</p>
156    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157        self.inner = self.inner.description(input.into());
158        self
159    }
160    /// <p>A description for the AFI.</p>
161    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162        self.inner = self.inner.set_description(input);
163        self
164    }
165    /// <p>A description for the AFI.</p>
166    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
167        self.inner.get_description()
168    }
169    /// <p>A name for the AFI.</p>
170    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171        self.inner = self.inner.name(input.into());
172        self
173    }
174    /// <p>A name for the AFI.</p>
175    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176        self.inner = self.inner.set_name(input);
177        self
178    }
179    /// <p>A name for the AFI.</p>
180    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
181        self.inner.get_name()
182    }
183    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring Idempotency</a>.</p>
184    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
185        self.inner = self.inner.client_token(input.into());
186        self
187    }
188    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring Idempotency</a>.</p>
189    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
190        self.inner = self.inner.set_client_token(input);
191        self
192    }
193    /// <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring Idempotency</a>.</p>
194    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
195        self.inner.get_client_token()
196    }
197    ///
198    /// Appends an item to `TagSpecifications`.
199    ///
200    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
201    ///
202    /// <p>The tags to apply to the FPGA image during creation.</p>
203    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
204        self.inner = self.inner.tag_specifications(input);
205        self
206    }
207    /// <p>The tags to apply to the FPGA image during creation.</p>
208    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
209        self.inner = self.inner.set_tag_specifications(input);
210        self
211    }
212    /// <p>The tags to apply to the FPGA image during creation.</p>
213    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
214        self.inner.get_tag_specifications()
215    }
216}