aws_sdk_ec2/client/
terminate_client_vpn_connections.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 [`TerminateClientVpnConnections`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_vpn_endpoint_id(impl Into<String>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::client_vpn_endpoint_id) / [`set_client_vpn_endpoint_id(Option<String>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::set_client_vpn_endpoint_id):<br>required: **true**<br><p>The ID of the Client VPN endpoint to which the client is connected.</p><br>
7    ///   - [`connection_id(impl Into<String>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::connection_id) / [`set_connection_id(Option<String>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::set_connection_id):<br>required: **false**<br><p>The ID of the client connection to be terminated.</p><br>
8    ///   - [`username(impl Into<String>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::set_username):<br>required: **false**<br><p>The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.</p><br>
9    ///   - [`dry_run(bool)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
10    /// - On success, responds with [`TerminateClientVpnConnectionsOutput`](crate::operation::terminate_client_vpn_connections::TerminateClientVpnConnectionsOutput) with field(s):
11    ///   - [`client_vpn_endpoint_id(Option<String>)`](crate::operation::terminate_client_vpn_connections::TerminateClientVpnConnectionsOutput::client_vpn_endpoint_id): <p>The ID of the Client VPN endpoint.</p>
12    ///   - [`username(Option<String>)`](crate::operation::terminate_client_vpn_connections::TerminateClientVpnConnectionsOutput::username): <p>The user who established the terminated client connections.</p>
13    ///   - [`connection_statuses(Option<Vec::<TerminateConnectionStatus>>)`](crate::operation::terminate_client_vpn_connections::TerminateClientVpnConnectionsOutput::connection_statuses): <p>The current state of the client connections.</p>
14    /// - On failure, responds with [`SdkError<TerminateClientVpnConnectionsError>`](crate::operation::terminate_client_vpn_connections::TerminateClientVpnConnectionsError)
15    pub fn terminate_client_vpn_connections(
16        &self,
17    ) -> crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder {
18        crate::operation::terminate_client_vpn_connections::builders::TerminateClientVpnConnectionsFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_ec2/client/terminate_client_vpn_connections.rs

aws_sdk_ec2/client/
terminate_client_vpn_connections.rs
