aws_sdk_networkfirewall/client/delete_firewall.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DeleteFirewall`](crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`firewall_name(impl Into<String>)`](crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder::firewall_name) / [`set_firewall_name(Option<String>)`](crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder::set_firewall_name):<br>required: **false**<br><p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
7 /// - [`firewall_arn(impl Into<String>)`](crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder::firewall_arn) / [`set_firewall_arn(Option<String>)`](crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder::set_firewall_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
8 /// - On success, responds with [`DeleteFirewallOutput`](crate::operation::delete_firewall::DeleteFirewallOutput) with field(s):
9 /// - [`firewall(Option<Firewall>)`](crate::operation::delete_firewall::DeleteFirewallOutput::firewall): <p>A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.</p> <p>In addition to the firewall endpoints that you define in this <code>Firewall</code> specification, you can create firewall endpoints in <code>VpcEndpointAssociation</code> resources for any VPC, in any Availability Zone where the firewall is already in use.</p> <p>The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding <code>FirewallStatus</code>. You can retrieve both the firewall and firewall status by calling <code>DescribeFirewall</code>.</p>
10 /// - [`firewall_status(Option<FirewallStatus>)`](crate::operation::delete_firewall::DeleteFirewallOutput::firewall_status): <p>Detailed information about the current status of a <code>Firewall</code>. You can retrieve this for a firewall by calling <code>DescribeFirewall</code> and providing the firewall name and ARN.</p> <p>The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.</p>
11 /// - On failure, responds with [`SdkError<DeleteFirewallError>`](crate::operation::delete_firewall::DeleteFirewallError)
12 pub fn delete_firewall(&self) -> crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder {
13 crate::operation::delete_firewall::builders::DeleteFirewallFluentBuilder::new(self.handle.clone())
14 }
15}