aws_sdk_ec2/client/
authorize_client_vpn_ingress.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 [`AuthorizeClientVpnIngress`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_vpn_endpoint_id(impl Into<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::client_vpn_endpoint_id) / [`set_client_vpn_endpoint_id(Option<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::set_client_vpn_endpoint_id):<br>required: **true**<br><p>The ID of the Client VPN endpoint.</p><br>
7    ///   - [`target_network_cidr(impl Into<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::target_network_cidr) / [`set_target_network_cidr(Option<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::set_target_network_cidr):<br>required: **true**<br><p>The IPv4 address range, in CIDR notation, of the network for which access is being authorized.</p><br>
8    ///   - [`access_group_id(impl Into<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::access_group_id) / [`set_access_group_id(Option<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::set_access_group_id):<br>required: **false**<br><p>The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if <code>AuthorizeAllGroups</code> is <code>false</code> or not specified.</p><br>
9    ///   - [`authorize_all_groups(bool)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::authorize_all_groups) / [`set_authorize_all_groups(Option<bool>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::set_authorize_all_groups):<br>required: **false**<br><p>Indicates whether to grant access to all clients. Specify <code>true</code> to grant all clients who successfully establish a VPN connection access to the network. Must be set to <code>true</code> if <code>AccessGroupId</code> is not specified.</p><br>
10    ///   - [`description(impl Into<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::set_description):<br>required: **false**<br><p>A brief description of the authorization rule.</p><br>
11    ///   - [`client_token(impl Into<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p><br>
12    ///   - [`dry_run(bool)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::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>
13    /// - On success, responds with [`AuthorizeClientVpnIngressOutput`](crate::operation::authorize_client_vpn_ingress::AuthorizeClientVpnIngressOutput) with field(s):
14    ///   - [`status(Option<ClientVpnAuthorizationRuleStatus>)`](crate::operation::authorize_client_vpn_ingress::AuthorizeClientVpnIngressOutput::status): <p>The current state of the authorization rule.</p>
15    /// - On failure, responds with [`SdkError<AuthorizeClientVpnIngressError>`](crate::operation::authorize_client_vpn_ingress::AuthorizeClientVpnIngressError)
16    pub fn authorize_client_vpn_ingress(&self) -> crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder {
17        crate::operation::authorize_client_vpn_ingress::builders::AuthorizeClientVpnIngressFluentBuilder::new(self.handle.clone())
18    }
19}