VpcEndpointArgs

data class VpcEndpointArgs(val policyDocument: Output<Any>? = null, val privateDnsEnabled: Output<Boolean>? = null, val routeTableIds: Output<List<String>>? = null, val securityGroupIds: Output<List<String>>? = null, val serviceName: Output<String>? = null, val subnetIds: Output<List<String>>? = null, val vpcEndpointType: Output<VpcEndpointType>? = null, val vpcId: Output<String>? = null) : ConvertibleToJava<VpcEndpointArgs>

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.

Constructors

Link copied to clipboard
constructor(policyDocument: Output<Any>? = null, privateDnsEnabled: Output<Boolean>? = null, routeTableIds: Output<List<String>>? = null, securityGroupIds: Output<List<String>>? = null, serviceName: Output<String>? = null, subnetIds: Output<List<String>>? = null, vpcEndpointType: Output<VpcEndpointType>? = null, vpcId: Output<String>? = null)

Properties

Link copied to clipboard
val policyDocument: Output<Any>? = null

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. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint. Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

Link copied to clipboard
val privateDnsEnabled: Output<Boolean>? = null

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`

Link copied to clipboard
val routeTableIds: Output<List<String>>? = null

The IDs of the route tables. Routing is supported only for gateway endpoints.

Link copied to clipboard
val securityGroupIds: Output<List<String>>? = null

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.

Link copied to clipboard
val serviceName: Output<String>? = null

The name of the endpoint service.

Link copied to clipboard
val subnetIds: Output<List<String>>? = null

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.

Link copied to clipboard
val vpcEndpointType: Output<VpcEndpointType>? = null

The type of endpoint. Default: Gateway

Link copied to clipboard
val vpcId: Output<String>? = null

The ID of the VPC.

Functions

Link copied to clipboard
open override fun toJava(): VpcEndpointArgs