class CfnVPCEndpoint (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnVPCEndpoint |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVPCEndpoint |
![]() | software.amazon.awscdk.services.ec2.CfnVPCEndpoint |
![]() | aws_cdk.aws_ec2.CfnVPCEndpoint |
![]() | aws-cdk-lib » aws_ec2 » CfnVPCEndpoint |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
declare const policyDocument: any;
const cfnVPCEndpoint = new ec2.CfnVPCEndpoint(this, 'MyCfnVPCEndpoint', {
vpcId: 'vpcId',
// the properties below are optional
dnsOptions: {
dnsRecordIpType: 'dnsRecordIpType',
privateDnsOnlyForInboundResolverEndpoint: 'privateDnsOnlyForInboundResolverEndpoint',
},
ipAddressType: 'ipAddressType',
policyDocument: policyDocument,
privateDnsEnabled: false,
resourceConfigurationArn: 'resourceConfigurationArn',
routeTableIds: ['routeTableIds'],
securityGroupIds: ['securityGroupIds'],
serviceName: 'serviceName',
serviceNetworkArn: 'serviceNetworkArn',
subnetIds: ['subnetIds'],
tags: [{
key: 'key',
value: 'value',
}],
vpcEndpointType: 'vpcEndpointType',
});
Initializer
new CfnVPCEndpoint(scope: Construct, id: string, props: CfnVPCEndpointProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.VPCEndpoint Props
Construct Props
Name | Type | Description |
---|---|---|
vpc | string | The ID of the VPC. |
dns | IResolvable | Dns | Describes the DNS options for an endpoint. |
ip | string | The supported IP address types. |
policy | any | An endpoint policy, which controls access to the service from the VPC. |
private | boolean | IResolvable | Indicate whether to associate a private hosted zone with the specified VPC. |
resource | string | The Amazon Resource Name (ARN) of the resource configuration. |
route | string[] | The IDs of the route tables. |
security | string[] | The IDs of the security groups to associate with the endpoint network interfaces. |
service | string | The name of the endpoint service. |
service | string | The Amazon Resource Name (ARN) of the service network. |
subnet | string[] | The IDs of the subnets in which to create endpoint network interfaces. |
tags? | Cfn [] | |
vpc | string | The type of endpoint. |
vpcId
Type:
string
The ID of the VPC.
dnsOptions?
Type:
IResolvable
|
Dns
(optional)
Describes the DNS options for an endpoint.
ipAddressType?
Type:
string
(optional)
The supported IP address types.
policyDocument?
Type:
any
(optional)
An endpoint policy, which controls access to the service from the VPC.
The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and AWS CloudFormation converts the policy to JSON format before calling the API actions for AWS PrivateLink . Alternatively, you can include the JSON directly in the YAML, as shown in the following Properties
section:
Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'
privateDnsEnabled?
Type:
boolean |
IResolvable
(optional)
Indicate whether to associate a private hosted zone with the specified VPC.
The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com
), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true
: enableDnsHostnames
and enableDnsSupport
.
This property is supported only for interface endpoints.
Default: false
resourceConfigurationArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the resource configuration.
routeTableIds?
Type:
string[]
(optional)
The IDs of the route tables.
Routing is supported only for gateway endpoints.
securityGroupIds?
Type:
string[]
(optional)
The IDs of the security groups to associate with the endpoint network interfaces.
If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
serviceName?
Type:
string
(optional)
The name of the endpoint service.
serviceNetworkArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the service network.
subnetIds?
Type:
string[]
(optional)
The IDs of the subnets in which to create endpoint network interfaces.
You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
tags?
Type:
Cfn
[]
(optional)
vpcEndpointType?
Type:
string
(optional)
The type of endpoint.
Default: Gateway
Properties
Name | Type | Description |
---|---|---|
attr | string | The date and time the VPC endpoint was created. |
attr | string[] | (Interface endpoints) The DNS entries for the endpoint. |
attr | string | The ID of the VPC endpoint. |
attr | string[] | (Interface endpoints) The network interface IDs. |
cdk | Tag | Tag Manager which manages the tags for this resource. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
vpc | string | The ID of the VPC. |
dns | IResolvable | Dns | Describes the DNS options for an endpoint. |
ip | string | The supported IP address types. |
policy | any | An endpoint policy, which controls access to the service from the VPC. |
private | boolean | IResolvable | Indicate whether to associate a private hosted zone with the specified VPC. |
resource | string | The Amazon Resource Name (ARN) of the resource configuration. |
route | string[] | The IDs of the route tables. |
security | string[] | The IDs of the security groups to associate with the endpoint network interfaces. |
service | string | The name of the endpoint service. |
service | string | The Amazon Resource Name (ARN) of the service network. |
subnet | string[] | The IDs of the subnets in which to create endpoint network interfaces. |
tags? | Cfn [] | |
vpc | string | The type of endpoint. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrCreationTimestamp
Type:
string
The date and time the VPC endpoint was created.
For example: Fri Sep 28 23:34:36 UTC 2018.
attrDnsEntries
Type:
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.
attrId
Type:
string
The ID of the VPC endpoint.
attrNetworkInterfaceIds
Type:
string[]
(Interface endpoints) The network interface IDs.
If you update the PrivateDnsEnabled
or SubnetIds
properties, the items in this list might change.
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
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 overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
vpcId
Type:
string
The ID of the VPC.
dnsOptions?
Type:
IResolvable
|
Dns
(optional)
Describes the DNS options for an endpoint.
ipAddressType?
Type:
string
(optional)
The supported IP address types.
policyDocument?
Type:
any
(optional)
An endpoint policy, which controls access to the service from the VPC.
privateDnsEnabled?
Type:
boolean |
IResolvable
(optional)
Indicate whether to associate a private hosted zone with the specified VPC.
resourceConfigurationArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the resource configuration.
routeTableIds?
Type:
string[]
(optional)
The IDs of the route tables.
securityGroupIds?
Type:
string[]
(optional)
The IDs of the security groups to associate with the endpoint network interfaces.
serviceName?
Type:
string
(optional)
The name of the endpoint service.
serviceNetworkArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the service network.
subnetIds?
Type:
string[]
(optional)
The IDs of the subnets in which to create endpoint network interfaces.
tags?
Type:
Cfn
[]
(optional)
vpcEndpointType?
Type:
string
(optional)
The type of endpoint.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }