Class: AWSCDK::EC2::CfnVPCEndpoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEC2::IVPCEndpointRef
Defined in:
ec2/cfn_vpc_endpoint.rb

Overview

Specifies a VPC endpoint.

A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS , an AWS Marketplace Partner, or another AWS accounts in your organization. For more information, see the AWS PrivateLink User Guide .

An endpoint of type Interface establishes connections between the subnets in your VPC and an AWS service , your own service, or a service hosted by another AWS account . With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.

An endpoint of type gateway serves as a target for a route in your route table for traffic destined for Amazon S3 or DynamoDB . You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to Amazon S3 , see Why can't I connect to an S3 bucket using a gateway VPC endpoint?

An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnVPCEndpoint

Create a new AWS::EC2::VPCEndpoint.

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::CfnVPCEndpointProps) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'ec2/cfn_vpc_endpoint.rb', line 26

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

Class Method Details

.arn_for_vpc_endpoint(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_vpc_endpoint(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVZQQ0VuZHBvaW50UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVPCEndpoint", "arnForVPCEndpoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


216
217
218
 
# File 'ec2/cfn_vpc_endpoint.rb', line 216

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

.from_vpc_endpoint_id(scope, id, vpc_endpoint_id) ⇒ AWSCDK::Interfaces::AWSEC2::IVPCEndpointRef

Creates a new IVPCEndpointRef from a vpcEndpointId.

Parameters:

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

Returns:



107
108
109
110
111
112
 
# File 'ec2/cfn_vpc_endpoint.rb', line 107

def self.from_vpc_endpoint_id(scope, id, vpc_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(vpc_endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcEndpointId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnVPCEndpoint", "fromVpcEndpointId", [scope, id, vpc_endpoint_id])
end

.is_cfn_vpc_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnVPCEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


118
119
120
121
 
# File 'ec2/cfn_vpc_endpoint.rb', line 118

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

.jsii_overridable_methods ⇒ Object 



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
89
90
91
92
 
# File 'ec2/cfn_vpc_endpoint.rb', line 34

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_creation_timestamp => { kind: :property, name: "attrCreationTimestamp", is_optional: false },
    :attr_dns_entries => { kind: :property, name: "attrDnsEntries", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_network_interface_ids => { kind: :property, name: "attrNetworkInterfaceIds", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :vpc_endpoint_ref => { kind: :property, name: "vpcEndpointRef", is_optional: false },
    :policy_document => { kind: :property, name: "policyDocument", is_optional: false },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: false },
    :dns_options => { kind: :property, name: "dnsOptions", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :private_dns_enabled => { kind: :property, name: "privateDnsEnabled", is_optional: true },
    :resource_configuration_arn => { kind: :property, name: "resourceConfigurationArn", is_optional: true },
    :route_table_ids => { kind: :property, name: "routeTableIds", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :service_name => { kind: :property, name: "serviceName", is_optional: true },
    :service_network_arn => { kind: :property, name: "serviceNetworkArn", is_optional: true },
    :service_region => { kind: :property, name: "serviceRegion", is_optional: true },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :vpc_endpoint_type => { kind: :property, name: "vpcEndpointType", 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.



480
481
482
483
 
# File 'ec2/cfn_vpc_endpoint.rb', line 480

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:



492
493
494
495
 
# File 'ec2/cfn_vpc_endpoint.rb', line 492

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:



502
503
504
505
 
# File 'ec2/cfn_vpc_endpoint.rb', line 502

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



513
514
515
516
517
 
# File 'ec2/cfn_vpc_endpoint.rb', line 513

def add_metadata(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.


570
571
572
573
574
 
# File 'ec2/cfn_vpc_endpoint.rb', line 570

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.



580
581
582
583
 
# File 'ec2/cfn_vpc_endpoint.rb', line 580

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.



592
593
594
595
596
 
# File 'ec2/cfn_vpc_endpoint.rb', line 592

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:



605
606
607
608
 
# File 'ec2/cfn_vpc_endpoint.rb', line 605

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:

Parameters:

See Also:



627
628
629
630
631
632
 
# File 'ec2/cfn_vpc_endpoint.rb', line 627

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_creation_timestamp ⇒ String

The date and time the VPC endpoint was created.

For example: Fri Sep 28 23:34:36 UTC 2018.

Returns:

  • (String) 


225
226
227
 
# File 'ec2/cfn_vpc_endpoint.rb', line 225

def attr_creation_timestamp()
  jsii_get_property("attrCreationTimestamp")
end

#attr_dns_entries ⇒ Array<String>

(Interface endpoints) The DNS entries for the 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>) 


240
241
242
 
# File 'ec2/cfn_vpc_endpoint.rb', line 240

def attr_dns_entries()
  jsii_get_property("attrDnsEntries")
end

#attr_id ⇒ String

The ID of the VPC endpoint.

Returns:

  • (String) 


247
248
249
 
# File 'ec2/cfn_vpc_endpoint.rb', line 247

def attr_id()
  jsii_get_property("attrId")
end

#attr_network_interface_ids ⇒ Array<String>

(Interface endpoints) The network interface IDs.

If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

Returns:

  • (Array<String>) 


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

def attr_network_interface_ids()
  jsii_get_property("attrNetworkInterfaceIds")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



263
264
265
 
# File 'ec2/cfn_vpc_endpoint.rb', line 263

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


174
175
176
 
# File 'ec2/cfn_vpc_endpoint.rb', line 174

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


636
637
638
639
 
# File 'ec2/cfn_vpc_endpoint.rb', line 636

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_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


179
180
181
 
# File 'ec2/cfn_vpc_endpoint.rb', line 179

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


186
187
188
 
# File 'ec2/cfn_vpc_endpoint.rb', line 186

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


131
132
133
 
# File 'ec2/cfn_vpc_endpoint.rb', line 131

def creation_stack()
  jsii_get_property("creationStack")
end

#dns_options ⇒ AWSCDK::IResolvable, ...

Describes the DNS options for an endpoint.

Returns:



301
302
303
 
# File 'ec2/cfn_vpc_endpoint.rb', line 301

def dns_options()
  jsii_get_property("dnsOptions")
end

#dns_options=(value) ⇒ Object 



305
306
307
308
309
 
# File 'ec2/cfn_vpc_endpoint.rb', line 305

def dns_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnVPCEndpoint::DNSOptionsSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuVlBDRW5kcG9pbnQuRG5zT3B0aW9uc1NwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "dnsOptions") unless value.nil?
  jsii_set_property("dnsOptions", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



191
192
193
 
# File 'ec2/cfn_vpc_endpoint.rb', line 191

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:



649
650
651
652
653
 
# File 'ec2/cfn_vpc_endpoint.rb', line 649

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



660
661
662
663
 
# File 'ec2/cfn_vpc_endpoint.rb', line 660

def get_metadata(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:



730
731
732
733
 
# File 'ec2/cfn_vpc_endpoint.rb', line 730

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

#ip_address_type ⇒ String?

The supported IP address types.

Returns:

  • (String, nil) 


314
315
316
 
# File 'ec2/cfn_vpc_endpoint.rb', line 314

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



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

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

#logical_id ⇒ String

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) 


143
144
145
 
# File 'ec2/cfn_vpc_endpoint.rb', line 143

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


126
127
128
 
# File 'ec2/cfn_vpc_endpoint.rb', line 126

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<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:



671
672
673
 
# File 'ec2/cfn_vpc_endpoint.rb', line 671

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



678
679
680
 
# File 'ec2/cfn_vpc_endpoint.rb', line 678

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.



471
472
473
474
 
# File 'ec2/cfn_vpc_endpoint.rb', line 471

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

#policy_document ⇒ Object

An endpoint policy, which controls access to the service from the VPC.

Returns:

  • (Object) 


277
278
279
 
# File 'ec2/cfn_vpc_endpoint.rb', line 277

def policy_document()
  jsii_get_property("policyDocument")
end

#policy_document=(value) ⇒ Object 



281
282
283
284
 
# File 'ec2/cfn_vpc_endpoint.rb', line 281

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

#private_dns_enabled ⇒ Boolean, ...

Indicate whether to associate a private hosted zone with the specified VPC.

Returns:



326
327
328
 
# File 'ec2/cfn_vpc_endpoint.rb', line 326

def private_dns_enabled()
  jsii_get_property("privateDnsEnabled")
end

#private_dns_enabled=(value) ⇒ Object 



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

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

#ref ⇒ String

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) 


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

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:



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

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


696
697
698
699
 
# File 'ec2/cfn_vpc_endpoint.rb', line 696

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:



706
707
708
709
710
 
# File 'ec2/cfn_vpc_endpoint.rb', line 706

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

#resource_configuration_arn ⇒ String?

The Amazon Resource Name (ARN) of the resource configuration.

Returns:

  • (String, nil) 


338
339
340
 
# File 'ec2/cfn_vpc_endpoint.rb', line 338

def resource_configuration_arn()
  jsii_get_property("resourceConfigurationArn")
end

#resource_configuration_arn=(value) ⇒ Object 



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

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

#route_table_ids ⇒ Array<String>?

The IDs of the route tables.

Returns:

  • (Array<String>, nil) 


350
351
352
 
# File 'ec2/cfn_vpc_endpoint.rb', line 350

def route_table_ids()
  jsii_get_property("routeTableIds")
end

#route_table_ids=(value) ⇒ Object 



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

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

#security_group_ids ⇒ Array<String>?

The IDs of the security groups to associate with the endpoint network interfaces.

Returns:

  • (Array<String>, nil) 


362
363
364
 
# File 'ec2/cfn_vpc_endpoint.rb', line 362

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



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

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

#service_name ⇒ String?

The name of the endpoint service.

Returns:

  • (String, nil) 


374
375
376
 
# File 'ec2/cfn_vpc_endpoint.rb', line 374

def service_name()
  jsii_get_property("serviceName")
end

#service_name=(value) ⇒ Object 



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

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

#service_network_arn ⇒ String?

The Amazon Resource Name (ARN) of the service network.

Returns:

  • (String, nil) 


386
387
388
 
# File 'ec2/cfn_vpc_endpoint.rb', line 386

def service_network_arn()
  jsii_get_property("serviceNetworkArn")
end

#service_network_arn=(value) ⇒ Object 



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

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

#service_region ⇒ String?

Describes a Region.

Returns:

  • (String, nil) 


398
399
400
 
# File 'ec2/cfn_vpc_endpoint.rb', line 398

def service_region()
  jsii_get_property("serviceRegion")
end

#service_region=(value) ⇒ Object 



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

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

#should_synthesize ⇒ Boolean

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.



715
716
717
 
# File 'ec2/cfn_vpc_endpoint.rb', line 715

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



152
153
154
 
# File 'ec2/cfn_vpc_endpoint.rb', line 152

def stack()
  jsii_get_property("stack")
end

#subnet_ids ⇒ Array<String>?

The IDs of the subnets in which to create endpoint network interfaces.

Returns:

  • (Array<String>, nil) 


410
411
412
 
# File 'ec2/cfn_vpc_endpoint.rb', line 410

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



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

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

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags to associate with the endpoint.

Returns:



422
423
424
 
# File 'ec2/cfn_vpc_endpoint.rb', line 422

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



426
427
428
429
430
 
# File 'ec2/cfn_vpc_endpoint.rb', line 426

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



447
448
449
 
# File 'ec2/cfn_vpc_endpoint.rb', line 447

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

#updated_properites ⇒ Hash{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}) 


199
200
201
 
# File 'ec2/cfn_vpc_endpoint.rb', line 199

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{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}) 


209
210
211
 
# File 'ec2/cfn_vpc_endpoint.rb', line 209

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


721
722
723
724
 
# File 'ec2/cfn_vpc_endpoint.rb', line 721

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

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

A reference to a VPCEndpoint resource.

Returns:



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

def vpc_endpoint_ref()
  jsii_get_property("vpcEndpointRef")
end

#vpc_endpoint_type ⇒ String?

The type of endpoint.

Returns:

  • (String, nil) 


435
436
437
 
# File 'ec2/cfn_vpc_endpoint.rb', line 435

def vpc_endpoint_type()
  jsii_get_property("vpcEndpointType")
end

#vpc_endpoint_type=(value) ⇒ Object 



439
440
441
442
 
# File 'ec2/cfn_vpc_endpoint.rb', line 439

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

#vpc_id ⇒ String

The ID of the VPC.

Returns:

  • (String) 


289
290
291
 
# File 'ec2/cfn_vpc_endpoint.rb', line 289

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



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

def vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId")
  jsii_set_property("vpcId", 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) 


460
461
462
463
464
465
 
# File 'ec2/cfn_vpc_endpoint.rb', line 460

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