| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.AuthorizeClientVpnIngress
Description
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
Synopsis
- data AuthorizeClientVpnIngress = AuthorizeClientVpnIngress' {}
- newAuthorizeClientVpnIngress :: Text -> Text -> AuthorizeClientVpnIngress
- authorizeClientVpnIngress_accessGroupId :: Lens' AuthorizeClientVpnIngress (Maybe Text)
- authorizeClientVpnIngress_authorizeAllGroups :: Lens' AuthorizeClientVpnIngress (Maybe Bool)
- authorizeClientVpnIngress_clientToken :: Lens' AuthorizeClientVpnIngress (Maybe Text)
- authorizeClientVpnIngress_description :: Lens' AuthorizeClientVpnIngress (Maybe Text)
- authorizeClientVpnIngress_dryRun :: Lens' AuthorizeClientVpnIngress (Maybe Bool)
- authorizeClientVpnIngress_clientVpnEndpointId :: Lens' AuthorizeClientVpnIngress Text
- authorizeClientVpnIngress_targetNetworkCidr :: Lens' AuthorizeClientVpnIngress Text
- data AuthorizeClientVpnIngressResponse = AuthorizeClientVpnIngressResponse' {}
- newAuthorizeClientVpnIngressResponse :: Int -> AuthorizeClientVpnIngressResponse
- authorizeClientVpnIngressResponse_status :: Lens' AuthorizeClientVpnIngressResponse (Maybe ClientVpnAuthorizationRuleStatus)
- authorizeClientVpnIngressResponse_httpStatus :: Lens' AuthorizeClientVpnIngressResponse Int
Creating a Request
data AuthorizeClientVpnIngress Source #
See: newAuthorizeClientVpnIngress smart constructor.
Constructors
| AuthorizeClientVpnIngress' | |
Fields
| |
Instances
newAuthorizeClientVpnIngress Source #
Arguments
| :: Text | |
| -> Text | |
| -> AuthorizeClientVpnIngress |
Create a value of AuthorizeClientVpnIngress with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessGroupId:AuthorizeClientVpnIngress', authorizeClientVpnIngress_accessGroupId - The ID of the group to grant access to, for example, the Active
Directory group or identity provider (IdP) group. Required if
AuthorizeAllGroups is false or not specified.
$sel:authorizeAllGroups:AuthorizeClientVpnIngress', authorizeClientVpnIngress_authorizeAllGroups - Indicates whether to grant access to all clients. Specify true to
grant all clients who successfully establish a VPN connection access to
the network. Must be set to true if AccessGroupId is not specified.
AuthorizeClientVpnIngress, authorizeClientVpnIngress_clientToken - Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
How to ensure idempotency.
AuthorizeClientVpnIngress, authorizeClientVpnIngress_description - A brief description of the authorization rule.
$sel:dryRun:AuthorizeClientVpnIngress', authorizeClientVpnIngress_dryRun - 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 DryRunOperation.
Otherwise, it is UnauthorizedOperation.
AuthorizeClientVpnIngress, authorizeClientVpnIngress_clientVpnEndpointId - The ID of the Client VPN endpoint.
$sel:targetNetworkCidr:AuthorizeClientVpnIngress', authorizeClientVpnIngress_targetNetworkCidr - The IPv4 address range, in CIDR notation, of the network for which
access is being authorized.
Request Lenses
authorizeClientVpnIngress_accessGroupId :: Lens' AuthorizeClientVpnIngress (Maybe Text) Source #
The ID of the group to grant access to, for example, the Active
Directory group or identity provider (IdP) group. Required if
AuthorizeAllGroups is false or not specified.
authorizeClientVpnIngress_authorizeAllGroups :: Lens' AuthorizeClientVpnIngress (Maybe Bool) Source #
Indicates whether to grant access to all clients. Specify true to
grant all clients who successfully establish a VPN connection access to
the network. Must be set to true if AccessGroupId is not specified.
authorizeClientVpnIngress_clientToken :: Lens' AuthorizeClientVpnIngress (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
authorizeClientVpnIngress_description :: Lens' AuthorizeClientVpnIngress (Maybe Text) Source #
A brief description of the authorization rule.
authorizeClientVpnIngress_dryRun :: Lens' AuthorizeClientVpnIngress (Maybe Bool) Source #
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 DryRunOperation.
Otherwise, it is UnauthorizedOperation.
authorizeClientVpnIngress_clientVpnEndpointId :: Lens' AuthorizeClientVpnIngress Text Source #
The ID of the Client VPN endpoint.
authorizeClientVpnIngress_targetNetworkCidr :: Lens' AuthorizeClientVpnIngress Text Source #
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
Destructuring the Response
data AuthorizeClientVpnIngressResponse Source #
See: newAuthorizeClientVpnIngressResponse smart constructor.
Constructors
| AuthorizeClientVpnIngressResponse' | |
Fields
| |
Instances
newAuthorizeClientVpnIngressResponse Source #
Arguments
| :: Int | |
| -> AuthorizeClientVpnIngressResponse |
Create a value of AuthorizeClientVpnIngressResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AuthorizeClientVpnIngressResponse, authorizeClientVpnIngressResponse_status - The current state of the authorization rule.
$sel:httpStatus:AuthorizeClientVpnIngressResponse', authorizeClientVpnIngressResponse_httpStatus - The response's http status code.
Response Lenses
authorizeClientVpnIngressResponse_status :: Lens' AuthorizeClientVpnIngressResponse (Maybe ClientVpnAuthorizationRuleStatus) Source #
The current state of the authorization rule.
authorizeClientVpnIngressResponse_httpStatus :: Lens' AuthorizeClientVpnIngressResponse Int Source #
The response's http status code.