Class: AWSCDK::EC2::CfnClientVpnAuthorizationRuleProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/cfn_client_vpn_authorization_rule_props.rb

Overview

Properties for defining a CfnClientVpnAuthorizationRule.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_vpn_endpoint_id:, target_network_cidr:, access_group_id: nil, authorize_all_groups: nil, description: nil) ⇒ CfnClientVpnAuthorizationRuleProps

Returns a new instance of CfnClientVpnAuthorizationRuleProps.

Parameters:

  • client_vpn_endpoint_id (String) —

    The ID of the Client VPN endpoint.

  • target_network_cidr (String) —

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

  • access_group_id (String, nil) (defaults to: nil) —

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

  • authorize_all_groups (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether to grant access to all clients.

  • description (String, nil) (defaults to: nil) —

    A brief description of the authorization rule.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 14

def initialize(client_vpn_endpoint_id:, target_network_cidr:, access_group_id: nil, authorize_all_groups: nil, description: nil)
  @client_vpn_endpoint_id = client_vpn_endpoint_id
  Jsii::Type.check_type(@client_vpn_endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientVpnEndpointId")
  @target_network_cidr = target_network_cidr
  Jsii::Type.check_type(@target_network_cidr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetNetworkCidr")
  @access_group_id = access_group_id
  Jsii::Type.check_type(@access_group_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessGroupId") unless @access_group_id.nil?
  @authorize_all_groups = authorize_all_groups
  Jsii::Type.check_type(@authorize_all_groups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "authorizeAllGroups") unless @authorize_all_groups.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#access_group_id ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



43
44
45
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 43

def access_group_id
  @access_group_id
end

#authorize_all_groups ⇒ Boolean, ... (readonly)

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.

Returns:

See Also:



50
51
52
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 50

def authorize_all_groups
  @authorize_all_groups
end

#client_vpn_endpoint_id ⇒ String (readonly)

The ID of the Client VPN endpoint.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 31

def client_vpn_endpoint_id
  @client_vpn_endpoint_id
end

#description ⇒ String? (readonly)

A brief description of the authorization rule.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 55

def description
  @description
end

#target_network_cidr ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



36
37
38
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 36

def target_network_cidr
  @target_network_cidr
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 57

def self.jsii_properties
  {
    :client_vpn_endpoint_id => "clientVpnEndpointId",
    :target_network_cidr => "targetNetworkCidr",
    :access_group_id => "accessGroupId",
    :authorize_all_groups => "authorizeAllGroups",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'ec2/cfn_client_vpn_authorization_rule_props.rb', line 67

def to_jsii
  result = {}
  result.merge!({
    "clientVpnEndpointId" => @client_vpn_endpoint_id,
    "targetNetworkCidr" => @target_network_cidr,
    "accessGroupId" => @access_group_id,
    "authorizeAllGroups" => @authorize_all_groups,
    "description" => @description,
  })
  result.compact
end