software.amazon.awscdk.services.ec2

Interface ClientVpnAuthorizationRuleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ClientVpnAuthorizationRuleProps

All Known Implementing Classes:

ClientVpnAuthorizationRuleOptions.Jsii$Proxy, ClientVpnAuthorizationRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.402Z")
 @Stability(value=Stable)
public interface ClientVpnAuthorizationRuleOptions
extends software.amazon.jsii.JsiiSerializable

Options for a ClientVpnAuthorizationRule.

Example:

 ClientVpnEndpoint endpoint = vpc.addClientVpnEndpoint("Endpoint", ClientVpnEndpointOptions.builder()
         .cidr("10.100.0.0/16")
         .serverCertificateArn("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id")
         .userBasedAuthentication(ClientVpnUserBasedAuthentication.federated(samlProvider))
         .authorizeAllUsersToVpcCidr(false)
         .build());
 endpoint.addAuthorizationRule("Rule", ClientVpnAuthorizationRuleOptions.builder()
         .cidr("10.0.10.0/32")
         .groupId("group-id")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientVpnAuthorizationRuleOptions.Builder A builder for ClientVpnAuthorizationRuleOptions
static class	ClientVpnAuthorizationRuleOptions.Jsii$Proxy An implementation for ClientVpnAuthorizationRuleOptions

Method Summary

Modifier and Type	Method and Description
static ClientVpnAuthorizationRuleOptions.Builder	builder()
String	getCidr() The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
default String	getDescription() A brief description of the authorization rule.
default String	getGroupId() The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCidr

@Stability(value=Stable)
 @NotNull
String getCidr()

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A brief description of the authorization rule.

Default: - no description

getGroupId

@Stability(value=Stable)
 @Nullable
default String getGroupId()

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.

Default: - authorize all groups

builder

@Stability(value=Stable)
static ClientVpnAuthorizationRuleOptions.Builder builder()

Returns:

a ClientVpnAuthorizationRuleOptions.Builder of ClientVpnAuthorizationRuleOptions