software.amazon.awscdk.services.ec2

Class CfnClientVpnAuthorizationRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnClientVpnAuthorizationRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.127Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnClientVpnAuthorizationRule.Builder A fluent builder for CfnClientVpnAuthorizationRule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnClientVpnAuthorizationRule(software.constructs.Construct scope, String id, CfnClientVpnAuthorizationRuleProps props) Create a new `AWS::EC2::ClientVpnAuthorizationRule`.
protected	CfnClientVpnAuthorizationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClientVpnAuthorizationRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccessGroupId() The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
Object	getAuthorizeAllGroups() Indicates whether to grant access to all clients.
protected Map<String,Object>	getCfnProperties()
String	getClientVpnEndpointId() The ID of the Client VPN endpoint.
String	getDescription() A brief description of the authorization rule.
String	getTargetNetworkCidr() The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessGroupId(String value) The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
void	setAuthorizeAllGroups(Boolean value) Indicates whether to grant access to all clients.
void	setAuthorizeAllGroups(IResolvable value) Indicates whether to grant access to all clients.
void	setClientVpnEndpointId(String value) The ID of the Client VPN endpoint.
void	setDescription(String value) A brief description of the authorization rule.
void	setTargetNetworkCidr(String value) The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnClientVpnAuthorizationRule

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

CfnClientVpnAuthorizationRule

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

CfnClientVpnAuthorizationRule

@Stability(value=Stable)
public CfnClientVpnAuthorizationRule(@NotNull
                                                              software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClientVpnEndpointId

@Stability(value=Stable)
 @NotNull
public String getClientVpnEndpointId()

The ID of the Client VPN endpoint.

setClientVpnEndpointId

@Stability(value=Stable)
public void setClientVpnEndpointId(@NotNull
                                                            String value)

The ID of the Client VPN endpoint.

getTargetNetworkCidr

@Stability(value=Stable)
 @NotNull
public String getTargetNetworkCidr()

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

setTargetNetworkCidr

@Stability(value=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(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getDescription()

A brief description of the authorization rule.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A brief description of the authorization rule.