Class: AWSCDK::EC2::InterfaceVPCEndpoint

Inherits:
VPCEndpoint
  • Object
show all
Includes:
IInterfaceVPCEndpoint
Defined in:
ec2/interface_vpc_endpoint.rb

Overview

A interface VPC endpoint.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ InterfaceVPCEndpoint

Returns a new instance of InterfaceVPCEndpoint.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/interface_vpc_endpoint.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::InterfaceVPCEndpointProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkludGVyZmFjZVZwY0VuZHBvaW50UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_interface_vpc_endpoint_attributes(scope, id, attrs) ⇒ AWSCDK::EC2::IInterfaceVPCEndpoint

Imports an existing interface VPC endpoint.

Parameters:

Returns:



50
51
52
53
54
55
56
 
# File 'ec2/interface_vpc_endpoint.rb', line 50

def self.from_interface_vpc_endpoint_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::EC2::InterfaceVPCEndpointAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkludGVyZmFjZVZwY0VuZHBvaW50QXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint", "fromInterfaceVpcEndpointAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'ec2/interface_vpc_endpoint.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :vpc_endpoint_id => { kind: :property, name: "vpcEndpointId", is_optional: false },
    :vpc_endpoint_ref => { kind: :property, name: "vpcEndpointRef", is_optional: false },
    :policy_document => { kind: :property, name: "policyDocument", is_optional: true },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :vpc_endpoint_creation_timestamp => { kind: :property, name: "vpcEndpointCreationTimestamp", is_optional: false },
    :vpc_endpoint_dns_entries => { kind: :property, name: "vpcEndpointDnsEntries", is_optional: false },
    :vpc_endpoint_network_interface_ids => { kind: :property, name: "vpcEndpointNetworkInterfaceIds", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_to_policy => { kind: :method, name: "addToPolicy", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


128
129
130
 
# File 'ec2/interface_vpc_endpoint.rb', line 128

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

Instance Method Details

#add_to_policy(statement) ⇒ void

This method returns an undefined value.

Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.

Not all interface VPC endpoints support policy. For more information see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html

Parameters:



270
271
272
273
 
# File 'ec2/interface_vpc_endpoint.rb', line 270

def add_to_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToPolicy", [statement])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



206
207
208
209
 
# File 'ec2/interface_vpc_endpoint.rb', line 206

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) ⇒ 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:



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

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

#connections ⇒ AWSCDK::EC2::Connections

Access to network connections.

Returns:



135
136
137
 
# File 'ec2/interface_vpc_endpoint.rb', line 135

def connections()
  jsii_get_property("connections")
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:



76
77
78
 
# File 'ec2/interface_vpc_endpoint.rb', line 76

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


229
230
231
 
# File 'ec2/interface_vpc_endpoint.rb', line 229

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


243
244
245
246
247
248
 
# File 'ec2/interface_vpc_endpoint.rb', line 243

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


258
259
260
261
 
# File 'ec2/interface_vpc_endpoint.rb', line 258

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


61
62
63
 
# File 'ec2/interface_vpc_endpoint.rb', line 61

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


90
91
92
 
# File 'ec2/interface_vpc_endpoint.rb', line 90

def physical_name()
  jsii_get_property("physicalName")
end

#policy_document ⇒ AWSCDK::IAM::PolicyDocument?

Returns:



116
117
118
 
# File 'ec2/interface_vpc_endpoint.rb', line 116

def policy_document()
  jsii_get_property("policyDocument")
end

#policy_document=(value) ⇒ Object 



120
121
122
123
 
# File 'ec2/interface_vpc_endpoint.rb', line 120

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

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



97
98
99
 
# File 'ec2/interface_vpc_endpoint.rb', line 97

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


176
177
178
 
# File 'ec2/interface_vpc_endpoint.rb', line 176

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

#vpc_endpoint_creation_timestamp ⇒ String

The date and time the interface VPC endpoint was created.

Returns:

  • (String) 


142
143
144
 
# File 'ec2/interface_vpc_endpoint.rb', line 142

def vpc_endpoint_creation_timestamp()
  jsii_get_property("vpcEndpointCreationTimestamp")
end

#vpc_endpoint_dns_entries ⇒ Array<String>

The DNS entries for the interface VPC endpoint.

Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

Returns:

  • (Array<String>) 


162
163
164
 
# File 'ec2/interface_vpc_endpoint.rb', line 162

def vpc_endpoint_dns_entries()
  jsii_get_property("vpcEndpointDnsEntries")
end

#vpc_endpoint_id ⇒ String

The interface VPC endpoint identifier.

Returns:

  • (String) 


104
105
106
 
# File 'ec2/interface_vpc_endpoint.rb', line 104

def vpc_endpoint_id()
  jsii_get_property("vpcEndpointId")
end

#vpc_endpoint_network_interface_ids ⇒ Array<String>

One or more network interfaces for the interface VPC endpoint.

Returns:

  • (Array<String>) 


169
170
171
 
# File 'ec2/interface_vpc_endpoint.rb', line 169

def vpc_endpoint_network_interface_ids()
  jsii_get_property("vpcEndpointNetworkInterfaceIds")
end

#vpc_endpoint_ref ⇒ AWSCDK::Interfaces::AWSEC2::VPCEndpointReference

A reference to a VPCEndpoint resource.

Returns:



111
112
113
 
# File 'ec2/interface_vpc_endpoint.rb', line 111

def vpc_endpoint_ref()
  jsii_get_property("vpcEndpointRef")
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) 


189
190
191
192
193
194
 
# File 'ec2/interface_vpc_endpoint.rb', line 189

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