aws_sdk_waf/operation/create_web_acl_migration_stack/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_web_acl_migration_stack::_create_web_acl_migration_stack_output::CreateWebAclMigrationStackOutputBuilder;
3
4pub use crate::operation::create_web_acl_migration_stack::_create_web_acl_migration_stack_input::CreateWebAclMigrationStackInputBuilder;
5
6impl crate::operation::create_web_acl_migration_stack::builders::CreateWebAclMigrationStackInputBuilder {
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_web_acl_migration_stack::CreateWebAclMigrationStackOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStackError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_web_acl_migration_stack();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateWebACLMigrationStack`.
24///
25/// <p>Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.</p>
26/// <p>This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html">Migrating your AWS WAF Classic resources to AWS WAF</a> in the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateWebACLMigrationStackFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::create_web_acl_migration_stack::builders::CreateWebAclMigrationStackInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::create_web_acl_migration_stack::CreateWebAclMigrationStackOutput,
36        crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStackError,
37    > for CreateWebACLMigrationStackFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::create_web_acl_migration_stack::CreateWebAclMigrationStackOutput,
45            crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStackError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl CreateWebACLMigrationStackFluentBuilder {
52    /// Creates a new `CreateWebACLMigrationStackFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the CreateWebACLMigrationStack as a reference.
61    pub fn as_input(&self) -> &crate::operation::create_web_acl_migration_stack::builders::CreateWebAclMigrationStackInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::create_web_acl_migration_stack::CreateWebAclMigrationStackOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStackError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStack::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStack::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::create_web_acl_migration_stack::CreateWebAclMigrationStackOutput,
98        crate::operation::create_web_acl_migration_stack::CreateWebACLMigrationStackError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.</p>
113    pub fn web_acl_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.web_acl_id(input.into());
115        self
116    }
117    /// <p>The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.</p>
118    pub fn set_web_acl_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_web_acl_id(input);
120        self
121    }
122    /// <p>The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.</p>
123    pub fn get_web_acl_id(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_web_acl_id()
125    }
126    /// <p>The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:</p>
127    /// <ul>
128    /// <li>
129    /// <p>The bucket name must start with <code>aws-waf-migration-</code>. For example, <code>aws-waf-migration-my-web-acl</code>.</p></li>
130    /// <li>
131    /// <p>The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.</p></li>
132    /// <li>
133    /// <p>The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.</p></li>
134    /// </ul>
135    pub fn s3_bucket_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136        self.inner = self.inner.s3_bucket_name(input.into());
137        self
138    }
139    /// <p>The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:</p>
140    /// <ul>
141    /// <li>
142    /// <p>The bucket name must start with <code>aws-waf-migration-</code>. For example, <code>aws-waf-migration-my-web-acl</code>.</p></li>
143    /// <li>
144    /// <p>The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.</p></li>
145    /// <li>
146    /// <p>The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.</p></li>
147    /// </ul>
148    pub fn set_s3_bucket_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.inner = self.inner.set_s3_bucket_name(input);
150        self
151    }
152    /// <p>The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:</p>
153    /// <ul>
154    /// <li>
155    /// <p>The bucket name must start with <code>aws-waf-migration-</code>. For example, <code>aws-waf-migration-my-web-acl</code>.</p></li>
156    /// <li>
157    /// <p>The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.</p></li>
158    /// <li>
159    /// <p>The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.</p></li>
160    /// </ul>
161    pub fn get_s3_bucket_name(&self) -> &::std::option::Option<::std::string::String> {
162        self.inner.get_s3_bucket_name()
163    }
164    /// <p>Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.</p>
165    pub fn ignore_unsupported_type(mut self, input: bool) -> Self {
166        self.inner = self.inner.ignore_unsupported_type(input);
167        self
168    }
169    /// <p>Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.</p>
170    pub fn set_ignore_unsupported_type(mut self, input: ::std::option::Option<bool>) -> Self {
171        self.inner = self.inner.set_ignore_unsupported_type(input);
172        self
173    }
174    /// <p>Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.</p>
175    pub fn get_ignore_unsupported_type(&self) -> &::std::option::Option<bool> {
176        self.inner.get_ignore_unsupported_type()
177    }
178}