aws_sdk_ec2/client/
get_active_vpn_tunnel_status.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 [`GetActiveVpnTunnelStatus`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`vpn_connection_id(impl Into<String>)`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::vpn_connection_id) / [`set_vpn_connection_id(Option<String>)`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::set_vpn_connection_id):<br>required: **true**<br><p>The ID of the VPN connection for which to retrieve the active tunnel status.</p><br>
7    ///   - [`vpn_tunnel_outside_ip_address(impl Into<String>)`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::vpn_tunnel_outside_ip_address) / [`set_vpn_tunnel_outside_ip_address(Option<String>)`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::set_vpn_tunnel_outside_ip_address):<br>required: **true**<br><p>The external IP address of the VPN tunnel for which to retrieve the active status.</p><br>
8    ///   - [`dry_run(bool)`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request.</p><br>
9    /// - On success, responds with [`GetActiveVpnTunnelStatusOutput`](crate::operation::get_active_vpn_tunnel_status::GetActiveVpnTunnelStatusOutput) with field(s):
10    ///   - [`active_vpn_tunnel_status(Option<ActiveVpnTunnelStatus>)`](crate::operation::get_active_vpn_tunnel_status::GetActiveVpnTunnelStatusOutput::active_vpn_tunnel_status): <p>Information about the current security configuration of the VPN tunnel.</p>
11    /// - On failure, responds with [`SdkError<GetActiveVpnTunnelStatusError>`](crate::operation::get_active_vpn_tunnel_status::GetActiveVpnTunnelStatusError)
12    pub fn get_active_vpn_tunnel_status(&self) -> crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder {
13        crate::operation::get_active_vpn_tunnel_status::builders::GetActiveVpnTunnelStatusFluentBuilder::new(self.handle.clone())
14    }
15}