Class: AWSCDK::EC2::CfnClientVpnEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSEC2::IClientVpnEndpointRef
Defined in:
ec2/cfn_client_vpn_endpoint.rb

Overview

Specifies a Client VPN endpoint.

A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnClientVpnEndpoint

Create a new AWS::EC2::ClientVpnEndpoint.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnClientVpnEndpointProps)

    Resource properties.



19
20
21
22
23
24
25
# File 'ec2/cfn_client_vpn_endpoint.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnClientVpnEndpointProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkNsaWVudFZwbkVuZHBvaW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_client_vpn_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String)


92
93
94
95
# File 'ec2/cfn_client_vpn_endpoint.rb', line 92

def self.arn_for_client_vpn_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUNsaWVudFZwbkVuZHBvaW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnClientVpnEndpoint", "arnForClientVpnEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


212
213
214
# File 'ec2/cfn_client_vpn_endpoint.rb', line 212

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.CfnClientVpnEndpoint", "CFN_RESOURCE_TYPE_NAME")
end

.from_client_vpn_endpoint_id(scope, id, client_vpn_endpoint_id) ⇒ AWSCDK::Interfaces::AWSEC2::IClientVpnEndpointRef

Creates a new IClientVpnEndpointRef from a clientVpnEndpointId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • client_vpn_endpoint_id (String)

Returns:



103
104
105
106
107
108
# File 'ec2/cfn_client_vpn_endpoint.rb', line 103

def self.from_client_vpn_endpoint_id(scope, id, client_vpn_endpoint_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(client_vpn_endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientVpnEndpointId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnClientVpnEndpoint", "fromClientVpnEndpointId", [scope, id, client_vpn_endpoint_id])
end

.is_cfn_client_vpn_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnClientVpnEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


114
115
116
117
# File 'ec2/cfn_client_vpn_endpoint.rb', line 114

def self.is_cfn_client_vpn_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnClientVpnEndpoint", "isCfnClientVpnEndpoint", [x])
end

.jsii_overridable_methodsObject



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'ec2/cfn_client_vpn_endpoint.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :client_vpn_endpoint_ref => { kind: :property, name: "clientVpnEndpointRef", is_optional: false },
    :authentication_options => { kind: :property, name: "authenticationOptions", is_optional: false },
    :connection_log_options => { kind: :property, name: "connectionLogOptions", is_optional: false },
    :server_certificate_arn => { kind: :property, name: "serverCertificateArn", is_optional: false },
    :client_cidr_block => { kind: :property, name: "clientCidrBlock", is_optional: true },
    :client_connect_options => { kind: :property, name: "clientConnectOptions", is_optional: true },
    :client_login_banner_options => { kind: :property, name: "clientLoginBannerOptions", is_optional: true },
    :client_route_enforcement_options => { kind: :property, name: "clientRouteEnforcementOptions", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :disconnect_on_session_timeout => { kind: :property, name: "disconnectOnSessionTimeout", is_optional: true },
    :dns_servers => { kind: :property, name: "dnsServers", is_optional: true },
    :endpoint_ip_address_type => { kind: :property, name: "endpointIpAddressType", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :self_service_portal => { kind: :property, name: "selfServicePortal", is_optional: true },
    :session_timeout_hours => { kind: :property, name: "sessionTimeoutHours", is_optional: true },
    :split_tunnel => { kind: :property, name: "splitTunnel", is_optional: true },
    :tag_specifications => { kind: :property, name: "tagSpecifications", is_optional: true },
    :traffic_ip_address_type => { kind: :property, name: "trafficIpAddressType", is_optional: true },
    :transit_gateway_configuration => { kind: :property, name: "transitGatewayConfiguration", is_optional: true },
    :transport_protocol => { kind: :property, name: "transportProtocol", is_optional: true },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: true },
    :vpn_port => { kind: :property, name: "vpnPort", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



519
520
521
522
# File 'ec2/cfn_client_vpn_endpoint.rb', line 519

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



531
532
533
534
# File 'ec2/cfn_client_vpn_endpoint.rb', line 531

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



541
542
543
544
# File 'ec2/cfn_client_vpn_endpoint.rb', line 541

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



552
553
554
555
556
# File 'ec2/cfn_client_vpn_endpoint.rb', line 552

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


609
610
611
612
613
# File 'ec2/cfn_client_vpn_endpoint.rb', line 609

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



619
620
621
622
# File 'ec2/cfn_client_vpn_endpoint.rb', line 619

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



631
632
633
634
635
# File 'ec2/cfn_client_vpn_endpoint.rb', line 631

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



644
645
646
647
# File 'ec2/cfn_client_vpn_endpoint.rb', line 644

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



666
667
668
669
670
671
# File 'ec2/cfn_client_vpn_endpoint.rb', line 666

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_idString

Returns:

  • (String)


217
218
219
# File 'ec2/cfn_client_vpn_endpoint.rb', line 217

def attr_id()
  jsii_get_property("attrId")
end

#authentication_optionsAWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::EC2::CfnClientVpnEndpoint::ClientAuthenticationRequestProperty>

Information about the authentication method to be used to authenticate clients.



231
232
233
# File 'ec2/cfn_client_vpn_endpoint.rb', line 231

def authentication_options()
  jsii_get_property("authenticationOptions")
end

#authentication_options=(value) ⇒ Object



235
236
237
238
# File 'ec2/cfn_client_vpn_endpoint.rb', line 235

def authentication_options=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkNsaWVudFZwbkVuZHBvaW50LkNsaWVudEF1dGhlbnRpY2F0aW9uUmVxdWVzdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "authenticationOptions")
  jsii_set_property("authenticationOptions", value)
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



165
166
167
# File 'ec2/cfn_client_vpn_endpoint.rb', line 165

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


170
171
172
# File 'ec2/cfn_client_vpn_endpoint.rb', line 170

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


675
676
677
678
# File 'ec2/cfn_client_vpn_endpoint.rb', line 675

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


175
176
177
# File 'ec2/cfn_client_vpn_endpoint.rb', line 175

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


182
183
184
# File 'ec2/cfn_client_vpn_endpoint.rb', line 182

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_cidr_blockString?

The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

Returns:

  • (String, nil)


268
269
270
# File 'ec2/cfn_client_vpn_endpoint.rb', line 268

def client_cidr_block()
  jsii_get_property("clientCidrBlock")
end

#client_cidr_block=(value) ⇒ Object



272
273
274
275
# File 'ec2/cfn_client_vpn_endpoint.rb', line 272

def client_cidr_block=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientCidrBlock") unless value.nil?
  jsii_set_property("clientCidrBlock", value)
end

#client_connect_optionsAWSCDK::IResolvable, ...

The options for managing connection authorization for new client connections.



280
281
282
# File 'ec2/cfn_client_vpn_endpoint.rb', line 280

def client_connect_options()
  jsii_get_property("clientConnectOptions")
end

#client_connect_options=(value) ⇒ Object



284
285
286
287
288
# File 'ec2/cfn_client_vpn_endpoint.rb', line 284

def client_connect_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnClientVpnEndpoint::ClientConnectOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuQ2xpZW50VnBuRW5kcG9pbnQuQ2xpZW50Q29ubmVjdE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "clientConnectOptions") unless value.nil?
  jsii_set_property("clientConnectOptions", value)
end

#client_login_banner_optionsAWSCDK::IResolvable, ...

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.



293
294
295
# File 'ec2/cfn_client_vpn_endpoint.rb', line 293

def ()
  jsii_get_property("clientLoginBannerOptions")
end

#client_login_banner_options=(value) ⇒ Object



297
298
299
300
301
# File 'ec2/cfn_client_vpn_endpoint.rb', line 297

def (value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnClientVpnEndpoint::ClientLoginBannerOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuQ2xpZW50VnBuRW5kcG9pbnQuQ2xpZW50TG9naW5CYW5uZXJPcHRpb25zUHJvcGVydHkifV19fQ==")), "clientLoginBannerOptions") unless value.nil?
  jsii_set_property("clientLoginBannerOptions", value)
end

#client_route_enforcement_optionsAWSCDK::IResolvable, ...

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.



306
307
308
# File 'ec2/cfn_client_vpn_endpoint.rb', line 306

def client_route_enforcement_options()
  jsii_get_property("clientRouteEnforcementOptions")
end

#client_route_enforcement_options=(value) ⇒ Object



310
311
312
313
314
# File 'ec2/cfn_client_vpn_endpoint.rb', line 310

def client_route_enforcement_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnClientVpnEndpoint::ClientRouteEnforcementOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuQ2xpZW50VnBuRW5kcG9pbnQuQ2xpZW50Um91dGVFbmZvcmNlbWVudE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "clientRouteEnforcementOptions") unless value.nil?
  jsii_set_property("clientRouteEnforcementOptions", value)
end

#client_vpn_endpoint_refAWSCDK::Interfaces::AWSEC2::ClientVpnEndpointReference

A reference to a ClientVpnEndpoint resource.



224
225
226
# File 'ec2/cfn_client_vpn_endpoint.rb', line 224

def client_vpn_endpoint_ref()
  jsii_get_property("clientVpnEndpointRef")
end

#connection_log_optionsAWSCDK::IResolvable, AWSCDK::EC2::CfnClientVpnEndpoint::ConnectionLogOptionsProperty

Information about the client connection logging options.



243
244
245
# File 'ec2/cfn_client_vpn_endpoint.rb', line 243

def connection_log_options()
  jsii_get_property("connectionLogOptions")
end

#connection_log_options=(value) ⇒ Object



247
248
249
250
251
# File 'ec2/cfn_client_vpn_endpoint.rb', line 247

def connection_log_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnClientVpnEndpoint::ConnectionLogOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuQ2xpZW50VnBuRW5kcG9pbnQuQ29ubmVjdGlvbkxvZ09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "connectionLogOptions")
  jsii_set_property("connectionLogOptions", value)
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


127
128
129
# File 'ec2/cfn_client_vpn_endpoint.rb', line 127

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

A brief description of the Client VPN endpoint.

Returns:

  • (String, nil)


319
320
321
# File 'ec2/cfn_client_vpn_endpoint.rb', line 319

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



323
324
325
326
# File 'ec2/cfn_client_vpn_endpoint.rb', line 323

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#disconnect_on_session_timeoutBoolean, ...

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.

Returns:



331
332
333
# File 'ec2/cfn_client_vpn_endpoint.rb', line 331

def disconnect_on_session_timeout()
  jsii_get_property("disconnectOnSessionTimeout")
end

#disconnect_on_session_timeout=(value) ⇒ Object



335
336
337
338
# File 'ec2/cfn_client_vpn_endpoint.rb', line 335

def disconnect_on_session_timeout=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disconnectOnSessionTimeout") unless value.nil?
  jsii_set_property("disconnectOnSessionTimeout", value)
end

#dns_serversArray<String>?

Information about the DNS servers to be used for DNS resolution.

Returns:

  • (Array<String>, nil)


343
344
345
# File 'ec2/cfn_client_vpn_endpoint.rb', line 343

def dns_servers()
  jsii_get_property("dnsServers")
end

#dns_servers=(value) ⇒ Object



347
348
349
350
# File 'ec2/cfn_client_vpn_endpoint.rb', line 347

def dns_servers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dnsServers") unless value.nil?
  jsii_set_property("dnsServers", value)
end

#endpoint_ip_address_typeString?

The IP address type of the Client VPN endpoint.

Returns:

  • (String, nil)


355
356
357
# File 'ec2/cfn_client_vpn_endpoint.rb', line 355

def endpoint_ip_address_type()
  jsii_get_property("endpointIpAddressType")
end

#endpoint_ip_address_type=(value) ⇒ Object



359
360
361
362
# File 'ec2/cfn_client_vpn_endpoint.rb', line 359

def endpoint_ip_address_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointIpAddressType") unless value.nil?
  jsii_set_property("endpointIpAddressType", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



187
188
189
# File 'ec2/cfn_client_vpn_endpoint.rb', line 187

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



688
689
690
691
692
# File 'ec2/cfn_client_vpn_endpoint.rb', line 688

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



699
700
701
702
# File 'ec2/cfn_client_vpn_endpoint.rb', line 699

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



769
770
771
772
# File 'ec2/cfn_client_vpn_endpoint.rb', line 769

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


139
140
141
# File 'ec2/cfn_client_vpn_endpoint.rb', line 139

def logical_id()
  jsii_get_property("logicalId")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


122
123
124
# File 'ec2/cfn_client_vpn_endpoint.rb', line 122

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



710
711
712
# File 'ec2/cfn_client_vpn_endpoint.rb', line 710

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



717
718
719
# File 'ec2/cfn_client_vpn_endpoint.rb', line 717

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



510
511
512
513
# File 'ec2/cfn_client_vpn_endpoint.rb', line 510

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


158
159
160
# File 'ec2/cfn_client_vpn_endpoint.rb', line 158

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



728
729
730
731
# File 'ec2/cfn_client_vpn_endpoint.rb', line 728

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


735
736
737
738
# File 'ec2/cfn_client_vpn_endpoint.rb', line 735

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



745
746
747
748
749
# File 'ec2/cfn_client_vpn_endpoint.rb', line 745

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_group_idsArray<String>?

The IDs of one or more security groups to apply to the target network.

Returns:

  • (Array<String>, nil)


367
368
369
# File 'ec2/cfn_client_vpn_endpoint.rb', line 367

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object



371
372
373
374
# File 'ec2/cfn_client_vpn_endpoint.rb', line 371

def security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless value.nil?
  jsii_set_property("securityGroupIds", value)
end

#self_service_portalString?

Specify whether to enable the self-service portal for the Client VPN endpoint.

Returns:

  • (String, nil)


379
380
381
# File 'ec2/cfn_client_vpn_endpoint.rb', line 379

def self_service_portal()
  jsii_get_property("selfServicePortal")
end

#self_service_portal=(value) ⇒ Object



383
384
385
386
# File 'ec2/cfn_client_vpn_endpoint.rb', line 383

def self_service_portal=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selfServicePortal") unless value.nil?
  jsii_set_property("selfServicePortal", value)
end

#server_certificate_arnString

The ARN of the server certificate.

Returns:

  • (String)


256
257
258
# File 'ec2/cfn_client_vpn_endpoint.rb', line 256

def server_certificate_arn()
  jsii_get_property("serverCertificateArn")
end

#server_certificate_arn=(value) ⇒ Object



260
261
262
263
# File 'ec2/cfn_client_vpn_endpoint.rb', line 260

def server_certificate_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverCertificateArn")
  jsii_set_property("serverCertificateArn", value)
end

#session_timeout_hoursNumeric?

The maximum VPN session duration time in hours.

Returns:

  • (Numeric, nil)


391
392
393
# File 'ec2/cfn_client_vpn_endpoint.rb', line 391

def session_timeout_hours()
  jsii_get_property("sessionTimeoutHours")
end

#session_timeout_hours=(value) ⇒ Object



395
396
397
398
# File 'ec2/cfn_client_vpn_endpoint.rb', line 395

def session_timeout_hours=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sessionTimeoutHours") unless value.nil?
  jsii_set_property("sessionTimeoutHours", value)
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



754
755
756
# File 'ec2/cfn_client_vpn_endpoint.rb', line 754

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#split_tunnelBoolean, ...

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

Returns:



403
404
405
# File 'ec2/cfn_client_vpn_endpoint.rb', line 403

def split_tunnel()
  jsii_get_property("splitTunnel")
end

#split_tunnel=(value) ⇒ Object



407
408
409
410
# File 'ec2/cfn_client_vpn_endpoint.rb', line 407

def split_tunnel=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "splitTunnel") unless value.nil?
  jsii_set_property("splitTunnel", value)
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



148
149
150
# File 'ec2/cfn_client_vpn_endpoint.rb', line 148

def stack()
  jsii_get_property("stack")
end

#tag_specificationsAWSCDK::IResolvable, ...

The tags to apply to the Client VPN endpoint during creation.



415
416
417
# File 'ec2/cfn_client_vpn_endpoint.rb', line 415

def tag_specifications()
  jsii_get_property("tagSpecifications")
end

#tag_specifications=(value) ⇒ Object



419
420
421
422
# File 'ec2/cfn_client_vpn_endpoint.rb', line 419

def tag_specifications=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkNsaWVudFZwbkVuZHBvaW50LlRhZ1NwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "tagSpecifications") unless value.nil?
  jsii_set_property("tagSpecifications", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



486
487
488
# File 'ec2/cfn_client_vpn_endpoint.rb', line 486

def to_string()
  jsii_call_method("toString", [])
end

#traffic_ip_address_typeString?

The IP address type of the Client VPN endpoint.

Returns:

  • (String, nil)


427
428
429
# File 'ec2/cfn_client_vpn_endpoint.rb', line 427

def traffic_ip_address_type()
  jsii_get_property("trafficIpAddressType")
end

#traffic_ip_address_type=(value) ⇒ Object



431
432
433
434
# File 'ec2/cfn_client_vpn_endpoint.rb', line 431

def traffic_ip_address_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trafficIpAddressType") unless value.nil?
  jsii_set_property("trafficIpAddressType", value)
end

#transit_gateway_configurationAWSCDK::IResolvable, ...



437
438
439
# File 'ec2/cfn_client_vpn_endpoint.rb', line 437

def transit_gateway_configuration()
  jsii_get_property("transitGatewayConfiguration")
end

#transit_gateway_configuration=(value) ⇒ Object



441
442
443
444
445
# File 'ec2/cfn_client_vpn_endpoint.rb', line 441

def transit_gateway_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnClientVpnEndpoint::TransitGatewayConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuQ2xpZW50VnBuRW5kcG9pbnQuVHJhbnNpdEdhdGV3YXlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "transitGatewayConfiguration") unless value.nil?
  jsii_set_property("transitGatewayConfiguration", value)
end

#transport_protocolString?

The transport protocol to be used by the VPN session.

Returns:

  • (String, nil)


450
451
452
# File 'ec2/cfn_client_vpn_endpoint.rb', line 450

def transport_protocol()
  jsii_get_property("transportProtocol")
end

#transport_protocol=(value) ⇒ Object



454
455
456
457
# File 'ec2/cfn_client_vpn_endpoint.rb', line 454

def transport_protocol=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transportProtocol") unless value.nil?
  jsii_set_property("transportProtocol", value)
end

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


195
196
197
# File 'ec2/cfn_client_vpn_endpoint.rb', line 195

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


205
206
207
# File 'ec2/cfn_client_vpn_endpoint.rb', line 205

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


760
761
762
763
# File 'ec2/cfn_client_vpn_endpoint.rb', line 760

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_idString?

The ID of the VPC to associate with the Client VPN endpoint.

Returns:

  • (String, nil)


462
463
464
# File 'ec2/cfn_client_vpn_endpoint.rb', line 462

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object



466
467
468
469
# File 'ec2/cfn_client_vpn_endpoint.rb', line 466

def vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") unless value.nil?
  jsii_set_property("vpcId", value)
end

#vpn_portNumeric?

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Returns:

  • (Numeric, nil)


474
475
476
# File 'ec2/cfn_client_vpn_endpoint.rb', line 474

def vpn_port()
  jsii_get_property("vpnPort")
end

#vpn_port=(value) ⇒ Object



478
479
480
481
# File 'ec2/cfn_client_vpn_endpoint.rb', line 478

def vpn_port=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "vpnPort") unless value.nil?
  jsii_set_property("vpnPort", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct)


499
500
501
502
503
504
# File 'ec2/cfn_client_vpn_endpoint.rb', line 499

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end