Module: AWSCDK::EC2::IClientVpnEndpoint

Includes:
IConnectable, IResource, Interfaces::AWSEC2::IClientVpnEndpointRef
Included in:
ClientVpnEndpoint
Defined in:
ec2/i_client_vpn_endpoint.rb

Overview

A client VPN endpoint.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'ec2/i_client_vpn_endpoint.rb', line 98

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :client_vpn_endpoint_ref => { kind: :property, name: "clientVpnEndpointRef", is_optional: false },
    :endpoint_id => { kind: :property, name: "endpointId", is_optional: false },
    :target_networks_associated => { kind: :property, name: "targetNetworksAssociated", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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).

Parameters:



93
94
95
96
 
# File 'ec2/i_client_vpn_endpoint.rb', line 93

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#client_vpn_endpoint_ref ⇒ AWSCDK::Interfaces::AWSEC2::ClientVpnEndpointReference

A reference to a ClientVpnEndpoint resource.

Returns:



49
50
51
 
# File 'ec2/i_client_vpn_endpoint.rb', line 49

def client_vpn_endpoint_ref()
  jsii_get_property("clientVpnEndpointRef")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



42
43
44
 
# File 'ec2/i_client_vpn_endpoint.rb', line 42

def connections()
  jsii_get_property("connections")
end

#endpoint_id ⇒ String

The endpoint ID.

Returns:

  • (String) 


56
57
58
 
# File 'ec2/i_client_vpn_endpoint.rb', line 56

def endpoint_id()
  jsii_get_property("endpointId")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



28
29
30
 
# File 'ec2/i_client_vpn_endpoint.rb', line 28

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


13
14
15
 
# File 'ec2/i_client_vpn_endpoint.rb', line 13

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



35
36
37
 
# File 'ec2/i_client_vpn_endpoint.rb', line 35

def stack()
  jsii_get_property("stack")
end

#target_networks_associated ⇒ Constructs::IDependable

Dependable that can be depended upon to force target networks associations.

Returns:

  • (Constructs::IDependable) 


63
64
65
 
# File 'ec2/i_client_vpn_endpoint.rb', line 63

def target_networks_associated()
  jsii_get_property("targetNetworksAssociated")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



74
75
76
77
78
79
 
# File 'ec2/i_client_vpn_endpoint.rb', line 74

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