aws_sdk_networkfirewall/client/describe_logging_configuration.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 [`DescribeLoggingConfiguration`](crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`firewall_arn(impl Into<String>)`](crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder::firewall_arn) / [`set_firewall_arn(Option<String>)`](crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder::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>
7 /// - [`firewall_name(impl Into<String>)`](crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder::firewall_name) / [`set_firewall_name(Option<String>)`](crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder::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>
8 /// - On success, responds with [`DescribeLoggingConfigurationOutput`](crate::operation::describe_logging_configuration::DescribeLoggingConfigurationOutput) with field(s):
9 /// - [`firewall_arn(Option<String>)`](crate::operation::describe_logging_configuration::DescribeLoggingConfigurationOutput::firewall_arn): <p>The Amazon Resource Name (ARN) of the firewall.</p>
10 /// - [`logging_configuration(Option<LoggingConfiguration>)`](crate::operation::describe_logging_configuration::DescribeLoggingConfigurationOutput::logging_configuration): <p>Defines how Network Firewall performs logging for a <code>Firewall</code>.</p>
11 /// - [`enable_monitoring_dashboard(Option<bool>)`](crate::operation::describe_logging_configuration::DescribeLoggingConfigurationOutput::enable_monitoring_dashboard): <p>A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.</p> <p>Returns <code>TRUE</code> when the firewall monitoring dashboard is enabled on the firewall. Returns <code>FALSE</code> when the firewall monitoring dashboard is not enabled on the firewall.</p>
12 /// - On failure, responds with [`SdkError<DescribeLoggingConfigurationError>`](crate::operation::describe_logging_configuration::DescribeLoggingConfigurationError)
13 pub fn describe_logging_configuration(
14 &self,
15 ) -> crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder {
16 crate::operation::describe_logging_configuration::builders::DescribeLoggingConfigurationFluentBuilder::new(self.handle.clone())
17 }
18}