aws_sdk_ec2/operation/create_key_pair/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_key_pair::_create_key_pair_output::CreateKeyPairOutputBuilder;
3
4pub use crate::operation::create_key_pair::_create_key_pair_input::CreateKeyPairInputBuilder;
5
6impl crate::operation::create_key_pair::builders::CreateKeyPairInputBuilder {
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_key_pair::CreateKeyPairOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_key_pair::CreateKeyPairError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_key_pair();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateKeyPair`.
24///
25/// <p>Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.</p>
26/// <p>The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using <code>ImportKeyPair</code>.</p>
27/// <p>You can have up to 5,000 key pairs per Amazon Web Services Region.</p>
28/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs</a> in the <i>Amazon EC2 User Guide</i>.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct CreateKeyPairFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::create_key_pair::builders::CreateKeyPairInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::create_key_pair::CreateKeyPairOutput,
38        crate::operation::create_key_pair::CreateKeyPairError,
39    > for CreateKeyPairFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::create_key_pair::CreateKeyPairOutput,
47            crate::operation::create_key_pair::CreateKeyPairError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl CreateKeyPairFluentBuilder {
54    /// Creates a new `CreateKeyPairFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the CreateKeyPair as a reference.
63    pub fn as_input(&self) -> &crate::operation::create_key_pair::builders::CreateKeyPairInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::create_key_pair::CreateKeyPairOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::create_key_pair::CreateKeyPairError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::create_key_pair::CreateKeyPair::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::create_key_pair::CreateKeyPair::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::create_key_pair::CreateKeyPairOutput,
100        crate::operation::create_key_pair::CreateKeyPairError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>A unique name for the key pair.</p>
115    /// <p>Constraints: Up to 255 ASCII characters</p>
116    pub fn key_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.key_name(input.into());
118        self
119    }
120    /// <p>A unique name for the key pair.</p>
121    /// <p>Constraints: Up to 255 ASCII characters</p>
122    pub fn set_key_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.inner = self.inner.set_key_name(input);
124        self
125    }
126    /// <p>A unique name for the key pair.</p>
127    /// <p>Constraints: Up to 255 ASCII characters</p>
128    pub fn get_key_name(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_key_name()
130    }
131    /// <p>The type of key pair. Note that ED25519 keys are not supported for Windows instances.</p>
132    /// <p>Default: <code>rsa</code></p>
133    pub fn key_type(mut self, input: crate::types::KeyType) -> Self {
134        self.inner = self.inner.key_type(input);
135        self
136    }
137    /// <p>The type of key pair. Note that ED25519 keys are not supported for Windows instances.</p>
138    /// <p>Default: <code>rsa</code></p>
139    pub fn set_key_type(mut self, input: ::std::option::Option<crate::types::KeyType>) -> Self {
140        self.inner = self.inner.set_key_type(input);
141        self
142    }
143    /// <p>The type of key pair. Note that ED25519 keys are not supported for Windows instances.</p>
144    /// <p>Default: <code>rsa</code></p>
145    pub fn get_key_type(&self) -> &::std::option::Option<crate::types::KeyType> {
146        self.inner.get_key_type()
147    }
148    ///
149    /// Appends an item to `TagSpecifications`.
150    ///
151    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
152    ///
153    /// <p>The tags to apply to the new key pair.</p>
154    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
155        self.inner = self.inner.tag_specifications(input);
156        self
157    }
158    /// <p>The tags to apply to the new key pair.</p>
159    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
160        self.inner = self.inner.set_tag_specifications(input);
161        self
162    }
163    /// <p>The tags to apply to the new key pair.</p>
164    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
165        self.inner.get_tag_specifications()
166    }
167    /// <p>The format of the key pair.</p>
168    /// <p>Default: <code>pem</code></p>
169    pub fn key_format(mut self, input: crate::types::KeyFormat) -> Self {
170        self.inner = self.inner.key_format(input);
171        self
172    }
173    /// <p>The format of the key pair.</p>
174    /// <p>Default: <code>pem</code></p>
175    pub fn set_key_format(mut self, input: ::std::option::Option<crate::types::KeyFormat>) -> Self {
176        self.inner = self.inner.set_key_format(input);
177        self
178    }
179    /// <p>The format of the key pair.</p>
180    /// <p>Default: <code>pem</code></p>
181    pub fn get_key_format(&self) -> &::std::option::Option<crate::types::KeyFormat> {
182        self.inner.get_key_format()
183    }
184    /// <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>
185    pub fn dry_run(mut self, input: bool) -> Self {
186        self.inner = self.inner.dry_run(input);
187        self
188    }
189    /// <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>
190    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
191        self.inner = self.inner.set_dry_run(input);
192        self
193    }
194    /// <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>
195    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
196        self.inner.get_dry_run()
197    }
198}
aws_sdk_ec2/operation/create_key_pair/builders.rs

aws_sdk_ec2/operation/create_key_pair/
builders.rs
