Class CfnClientVpnAuthorizationRule
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnClientVpnAuthorizationRule
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnClientVpnAuthorizationRule
(Construct scope, String id, CfnClientVpnAuthorizationRuleProps props) Create a newAWS::EC2::ClientVpnAuthorizationRule
.protected
CfnClientVpnAuthorizationRule
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnClientVpnAuthorizationRule
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.Indicates whether to grant access to all clients.The ID of the Client VPN endpoint.A brief description of the authorization rule.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.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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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 Details
-
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 newAWS::EC2::ClientVpnAuthorizationRule
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getClientVpnEndpointId
The ID of the Client VPN endpoint. -
setClientVpnEndpointId
The ID of the Client VPN endpoint. -
getTargetNetworkCidr
The IPv4 address range, in CIDR notation, of the network for which access is being authorized. -
setTargetNetworkCidr
The IPv4 address range, in CIDR notation, of the network for which access is being authorized. -
getAccessGroupId
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.Required if
AuthorizeAllGroups
isfalse
or not specified. -
setAccessGroupId
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.Required if
AuthorizeAllGroups
isfalse
or not specified. -
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 totrue
ifAccessGroupId
is not specified. -
setAuthorizeAllGroups
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 totrue
ifAccessGroupId
is not specified. -
setAuthorizeAllGroups
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 totrue
ifAccessGroupId
is not specified. -
getDescription
A brief description of the authorization rule. -
setDescription
A brief description of the authorization rule.
-