@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:32.235Z") public class CfnClientVpnAuthorizationRule extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnClientVpnAuthorizationRule.Builder
A fluent builder for
CfnClientVpnAuthorizationRule . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnClientVpnAuthorizationRule(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAccessGroupId()
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
|
java.lang.Object |
getAuthorizeAllGroups()
Indicates whether to grant access to all clients.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getClientVpnEndpointId()
The ID of the Client VPN endpoint.
|
java.lang.String |
getDescription()
A brief description of the authorization rule.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAccessGroupId(java.lang.String value)
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
|
void |
setAuthorizeAllGroups(java.lang.Boolean value)
Indicates whether to grant access to all clients.
|
void |
setAuthorizeAllGroups(IResolvable value)
Indicates whether to grant access to all clients.
|
void |
setClientVpnEndpointId(java.lang.String value)
The ID of the Client VPN endpoint.
|
void |
setDescription(java.lang.String value)
A brief description of the authorization rule.
|
void |
setTargetNetworkCidr(java.lang.String value)
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnClientVpnAuthorizationRule(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnClientVpnAuthorizationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnClientVpnAuthorizationRule(Construct scope, java.lang.String id, CfnClientVpnAuthorizationRuleProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getClientVpnEndpointId()
public void setClientVpnEndpointId(java.lang.String value)
public java.lang.String getTargetNetworkCidr()
public void setTargetNetworkCidr(java.lang.String value)
public java.lang.String getAccessGroupId()
Required if AuthorizeAllGroups
is false
or not specified.
public void setAccessGroupId(java.lang.String value)
Required if AuthorizeAllGroups
is false
or not specified.
public java.lang.Object getAuthorizeAllGroups()
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.
public void setAuthorizeAllGroups(java.lang.Boolean value)
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.
public void setAuthorizeAllGroups(IResolvable value)
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.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)