aws_sdk_directconnect/operation/associate_mac_sec_key/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::associate_mac_sec_key::_associate_mac_sec_key_output::AssociateMacSecKeyOutputBuilder;
3
4pub use crate::operation::associate_mac_sec_key::_associate_mac_sec_key_input::AssociateMacSecKeyInputBuilder;
5
6impl crate::operation::associate_mac_sec_key::builders::AssociateMacSecKeyInputBuilder {
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::associate_mac_sec_key::AssociateMacSecKeyOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::associate_mac_sec_key::AssociateMacSecKeyError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.associate_mac_sec_key();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `AssociateMacSecKey`.
24///
25/// <p>Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.</p>
26/// <p>You must supply either the <code>secretARN,</code> or the CKN/CAK (<code>ckn</code> and <code>cak</code>) pair in the request.</p>
27/// <p>For information about MAC Security (MACsec) key considerations, see <a href="https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-key-consideration">MACsec pre-shared CKN/CAK key considerations </a> in the <i>Direct Connect User Guide</i>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct AssociateMacSecKeyFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::associate_mac_sec_key::builders::AssociateMacSecKeyInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::associate_mac_sec_key::AssociateMacSecKeyOutput,
37        crate::operation::associate_mac_sec_key::AssociateMacSecKeyError,
38    > for AssociateMacSecKeyFluentBuilder
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::associate_mac_sec_key::AssociateMacSecKeyOutput,
46            crate::operation::associate_mac_sec_key::AssociateMacSecKeyError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl AssociateMacSecKeyFluentBuilder {
53    /// Creates a new `AssociateMacSecKeyFluentBuilder`.
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 AssociateMacSecKey as a reference.
62    pub fn as_input(&self) -> &crate::operation::associate_mac_sec_key::builders::AssociateMacSecKeyInputBuilder {
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::associate_mac_sec_key::AssociateMacSecKeyOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::associate_mac_sec_key::AssociateMacSecKeyError,
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::associate_mac_sec_key::AssociateMacSecKey::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::associate_mac_sec_key::AssociateMacSecKey::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::associate_mac_sec_key::AssociateMacSecKeyOutput,
99        crate::operation::associate_mac_sec_key::AssociateMacSecKeyError,
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 ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
114    /// <p>You can use <code>DescribeConnections</code> or <code>DescribeLags</code> to retrieve connection ID.</p>
115    pub fn connection_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.connection_id(input.into());
117        self
118    }
119    /// <p>The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
120    /// <p>You can use <code>DescribeConnections</code> or <code>DescribeLags</code> to retrieve connection ID.</p>
121    pub fn set_connection_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_connection_id(input);
123        self
124    }
125    /// <p>The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
126    /// <p>You can use <code>DescribeConnections</code> or <code>DescribeLags</code> to retrieve connection ID.</p>
127    pub fn get_connection_id(&self) -> &::std::option::Option<::std::string::String> {
128        self.inner.get_connection_id()
129    }
130    /// <p>The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.</p>
131    /// <p>You can use <code>DescribeConnections</code> or <code>DescribeLags</code> to retrieve the MAC Security (MACsec) secret key.</p>
132    /// <p>If you use this request parameter, you do not use the <code>ckn</code> and <code>cak</code> request parameters.</p>
133    pub fn secret_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134        self.inner = self.inner.secret_arn(input.into());
135        self
136    }
137    /// <p>The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.</p>
138    /// <p>You can use <code>DescribeConnections</code> or <code>DescribeLags</code> to retrieve the MAC Security (MACsec) secret key.</p>
139    /// <p>If you use this request parameter, you do not use the <code>ckn</code> and <code>cak</code> request parameters.</p>
140    pub fn set_secret_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
141        self.inner = self.inner.set_secret_arn(input);
142        self
143    }
144    /// <p>The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.</p>
145    /// <p>You can use <code>DescribeConnections</code> or <code>DescribeLags</code> to retrieve the MAC Security (MACsec) secret key.</p>
146    /// <p>If you use this request parameter, you do not use the <code>ckn</code> and <code>cak</code> request parameters.</p>
147    pub fn get_secret_arn(&self) -> &::std::option::Option<::std::string::String> {
148        self.inner.get_secret_arn()
149    }
150    /// <p>The MAC Security (MACsec) CKN to associate with the dedicated connection.</p>
151    /// <p>You can create the CKN/CAK pair using an industry standard tool.</p>
152    /// <p>The valid values are 64 hexadecimal characters (0-9, A-E).</p>
153    /// <p>If you use this request parameter, you must use the <code>cak</code> request parameter and not use the <code>secretARN</code> request parameter.</p>
154    pub fn ckn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.ckn(input.into());
156        self
157    }
158    /// <p>The MAC Security (MACsec) CKN to associate with the dedicated connection.</p>
159    /// <p>You can create the CKN/CAK pair using an industry standard tool.</p>
160    /// <p>The valid values are 64 hexadecimal characters (0-9, A-E).</p>
161    /// <p>If you use this request parameter, you must use the <code>cak</code> request parameter and not use the <code>secretARN</code> request parameter.</p>
162    pub fn set_ckn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163        self.inner = self.inner.set_ckn(input);
164        self
165    }
166    /// <p>The MAC Security (MACsec) CKN to associate with the dedicated connection.</p>
167    /// <p>You can create the CKN/CAK pair using an industry standard tool.</p>
168    /// <p>The valid values are 64 hexadecimal characters (0-9, A-E).</p>
169    /// <p>If you use this request parameter, you must use the <code>cak</code> request parameter and not use the <code>secretARN</code> request parameter.</p>
170    pub fn get_ckn(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_ckn()
172    }
173    /// <p>The MAC Security (MACsec) CAK to associate with the dedicated connection.</p>
174    /// <p>You can create the CKN/CAK pair using an industry standard tool.</p>
175    /// <p>The valid values are 64 hexadecimal characters (0-9, A-E).</p>
176    /// <p>If you use this request parameter, you must use the <code>ckn</code> request parameter and not use the <code>secretARN</code> request parameter.</p>
177    pub fn cak(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
178        self.inner = self.inner.cak(input.into());
179        self
180    }
181    /// <p>The MAC Security (MACsec) CAK to associate with the dedicated connection.</p>
182    /// <p>You can create the CKN/CAK pair using an industry standard tool.</p>
183    /// <p>The valid values are 64 hexadecimal characters (0-9, A-E).</p>
184    /// <p>If you use this request parameter, you must use the <code>ckn</code> request parameter and not use the <code>secretARN</code> request parameter.</p>
185    pub fn set_cak(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
186        self.inner = self.inner.set_cak(input);
187        self
188    }
189    /// <p>The MAC Security (MACsec) CAK to associate with the dedicated connection.</p>
190    /// <p>You can create the CKN/CAK pair using an industry standard tool.</p>
191    /// <p>The valid values are 64 hexadecimal characters (0-9, A-E).</p>
192    /// <p>If you use this request parameter, you must use the <code>ckn</code> request parameter and not use the <code>secretARN</code> request parameter.</p>
193    pub fn get_cak(&self) -> &::std::option::Option<::std::string::String> {
194        self.inner.get_cak()
195    }
196}