Package software.amazon.awscdk.services.ec2

Class CfnClientVpnAuthorizationRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnClientVpnAuthorizationRule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.433Z") @Stability(Stable) public class CfnClientVpnAuthorizationRule extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::ClientVpnAuthorizationRule.

Specifies an ingress authorization rule to add 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 AWS or on-premises networks.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnClientVpnAuthorizationRule cfnClientVpnAuthorizationRule = CfnClientVpnAuthorizationRule.Builder.create(this, "MyCfnClientVpnAuthorizationRule")
         .clientVpnEndpointId("clientVpnEndpointId")
         .targetNetworkCidr("targetNetworkCidr")
         // the properties below are optional
         .accessGroupId("accessGroupId")
         .authorizeAllGroups(false)
         .description("description")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnClientVpnAuthorizationRule

      protected CfnClientVpnAuthorizationRule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnClientVpnAuthorizationRule

      protected CfnClientVpnAuthorizationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnClientVpnAuthorizationRule

      @Stability(Stable) public CfnClientVpnAuthorizationRule(@NotNull Construct scope, @NotNull String id, @NotNull CfnClientVpnAuthorizationRuleProps props)
      Create a new AWS::EC2::ClientVpnAuthorizationRule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClientVpnEndpointId

      @Stability(Stable) @NotNull public String getClientVpnEndpointId()
      The ID of the Client VPN endpoint.

    • setClientVpnEndpointId

      @Stability(Stable) public void setClientVpnEndpointId(@NotNull String value)
      The ID of the Client VPN endpoint.

    • getTargetNetworkCidr

      @Stability(Stable) @NotNull public String getTargetNetworkCidr()
      The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

    • setTargetNetworkCidr

      @Stability(Stable) public void setTargetNetworkCidr(@NotNull String value)
      The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

    • getAccessGroupId

      @Stability(Stable) @Nullable public String getAccessGroupId()
      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.

    • setAccessGroupId

      @Stability(Stable) public void setAccessGroupId(@Nullable String value)
      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.

    • getAuthorizeAllGroups

      @Stability(Stable) @Nullable public Object getAuthorizeAllGroups()
      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.

    • setAuthorizeAllGroups

      @Stability(Stable) public void setAuthorizeAllGroups(@Nullable Boolean value)
      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.

    • setAuthorizeAllGroups

      @Stability(Stable) public void setAuthorizeAllGroups(@Nullable IResolvable value)
      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A brief description of the authorization rule.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A brief description of the authorization rule.