aws_sdk_wafv2/operation/create_api_key/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_api_key::_create_api_key_output::CreateApiKeyOutputBuilder;
3
4pub use crate::operation::create_api_key::_create_api_key_input::CreateApiKeyInputBuilder;
5
6impl crate::operation::create_api_key::builders::CreateApiKeyInputBuilder {
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_api_key::CreateApiKeyOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_api_key::CreateAPIKeyError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_api_key();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateAPIKey`.
24///
25/// <p>Creates an API key that contains a set of token domains.</p>
26/// <p>API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>
27/// <p>You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct CreateAPIKeyFluentBuilder {
30 handle: ::std::sync::Arc<crate::client::Handle>,
31 inner: crate::operation::create_api_key::builders::CreateApiKeyInputBuilder,
32 config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35 crate::client::customize::internal::CustomizableSend<
36 crate::operation::create_api_key::CreateApiKeyOutput,
37 crate::operation::create_api_key::CreateAPIKeyError,
38 > for CreateAPIKeyFluentBuilder
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_api_key::CreateApiKeyOutput,
46 crate::operation::create_api_key::CreateAPIKeyError,
47 >,
48 > {
49 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50 }
51}
52impl CreateAPIKeyFluentBuilder {
53 /// Creates a new `CreateAPIKeyFluentBuilder`.
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 CreateAPIKey as a reference.
62 pub fn as_input(&self) -> &crate::operation::create_api_key::builders::CreateApiKeyInputBuilder {
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_api_key::CreateApiKeyOutput,
77 ::aws_smithy_runtime_api::client::result::SdkError<
78 crate::operation::create_api_key::CreateAPIKeyError,
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_api_key::CreateAPIKey::operation_runtime_plugins(
87 self.handle.runtime_plugins.clone(),
88 &self.handle.conf,
89 self.config_override,
90 );
91 crate::operation::create_api_key::CreateAPIKey::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_api_key::CreateApiKeyOutput,
99 crate::operation::create_api_key::CreateAPIKeyError,
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>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
114 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
115 /// <ul>
116 /// <li>
117 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
118 /// <li>
119 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
120 /// </ul>
121 pub fn scope(mut self, input: crate::types::Scope) -> Self {
122 self.inner = self.inner.scope(input);
123 self
124 }
125 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
126 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
127 /// <ul>
128 /// <li>
129 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
130 /// <li>
131 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
132 /// </ul>
133 pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
134 self.inner = self.inner.set_scope(input);
135 self
136 }
137 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
138 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
139 /// <ul>
140 /// <li>
141 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
142 /// <li>
143 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
144 /// </ul>
145 pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
146 self.inner.get_scope()
147 }
148 ///
149 /// Appends an item to `TokenDomains`.
150 ///
151 /// To override the contents of this collection use [`set_token_domains`](Self::set_token_domains).
152 ///
153 /// <p>The client application domains that you want to use this API key for.</p>
154 /// <p>Example JSON: <code>"TokenDomains": \["abc.com", "store.abc.com"\]</code></p>
155 /// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
156 pub fn token_domains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
157 self.inner = self.inner.token_domains(input.into());
158 self
159 }
160 /// <p>The client application domains that you want to use this API key for.</p>
161 /// <p>Example JSON: <code>"TokenDomains": \["abc.com", "store.abc.com"\]</code></p>
162 /// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
163 pub fn set_token_domains(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
164 self.inner = self.inner.set_token_domains(input);
165 self
166 }
167 /// <p>The client application domains that you want to use this API key for.</p>
168 /// <p>Example JSON: <code>"TokenDomains": \["abc.com", "store.abc.com"\]</code></p>
169 /// <p>Public suffixes aren't allowed. For example, you can't use <code>gov.au</code> or <code>co.uk</code> as token domains.</p>
170 pub fn get_token_domains(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
171 self.inner.get_token_domains()
172 }
173}