software.amazon.awscdk.services.ec2

Class CfnVPCEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnVPCEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVPCEndpoint>

Enclosing class:

CfnVPCEndpoint

@Stability(value=Stable)
public static final class CfnVPCEndpoint.Builder
extends Object
implements software.amazon.jsii.Builder<CfnVPCEndpoint>

A fluent builder for CfnVPCEndpoint.

Method Summary

Modifier and Type	Method and Description
CfnVPCEndpoint	build()
static CfnVPCEndpoint.Builder	create(software.constructs.Construct scope, String id)
CfnVPCEndpoint.Builder	policyDocument(Object policyDocument) A policy that controls access to the service from the VPC.
CfnVPCEndpoint.Builder	privateDnsEnabled(Boolean privateDnsEnabled) Indicate whether to associate a private hosted zone with the specified VPC.
CfnVPCEndpoint.Builder	privateDnsEnabled(IResolvable privateDnsEnabled) Indicate whether to associate a private hosted zone with the specified VPC.
CfnVPCEndpoint.Builder	routeTableIds(List<String> routeTableIds) The route table IDs.
CfnVPCEndpoint.Builder	securityGroupIds(List<String> securityGroupIds) The IDs of the security groups to associate with the endpoint network interface.
CfnVPCEndpoint.Builder	serviceName(String serviceName) The service name.
CfnVPCEndpoint.Builder	subnetIds(List<String> subnetIds) The ID of the subnets in which to create an endpoint network interface.
CfnVPCEndpoint.Builder	vpcEndpointType(String vpcEndpointType) The type of endpoint.
CfnVPCEndpoint.Builder	vpcId(String vpcId) The ID of the VPC in which the endpoint will be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnVPCEndpoint.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnVPCEndpoint.Builder.

serviceName

@Stability(value=Stable)
public CfnVPCEndpoint.Builder serviceName(String serviceName)

The service name.

To list the available services, use DescribeVpcEndpointServices . Otherwise, get the name from the service provider.

Parameters:

serviceName - The service name. This parameter is required.

Returns:

this

vpcId

@Stability(value=Stable)
public CfnVPCEndpoint.Builder vpcId(String vpcId)

The ID of the VPC in which the endpoint will be used.

Parameters:

vpcId - The ID of the VPC in which the endpoint will be used. This parameter is required.

Returns:

this

policyDocument

@Stability(value=Stable)
public CfnVPCEndpoint.Builder policyDocument(Object policyDocument)

A policy that controls access to the service from the VPC.

If this parameter is not specified, the default 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. AWS CloudFormation converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.

Parameters:

policyDocument - A policy that controls access to the service from the VPC. This parameter is required.

Returns:

this

privateDnsEnabled

@Stability(value=Stable)
public CfnVPCEndpoint.Builder privateDnsEnabled(Boolean privateDnsEnabled)

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

Parameters:

privateDnsEnabled - Indicate whether to associate a private hosted zone with the specified VPC. This parameter is required.

Returns:

this

privateDnsEnabled

@Stability(value=Stable)
public CfnVPCEndpoint.Builder privateDnsEnabled(IResolvable privateDnsEnabled)

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

Parameters:

privateDnsEnabled - Indicate whether to associate a private hosted zone with the specified VPC. This parameter is required.

Returns:

this

routeTableIds

@Stability(value=Stable)
public CfnVPCEndpoint.Builder routeTableIds(List<String> routeTableIds)

The route table IDs.

Routing is supported only for gateway endpoints.

Parameters:

routeTableIds - The route table IDs. This parameter is required.

Returns:

this

securityGroupIds

@Stability(value=Stable)
public CfnVPCEndpoint.Builder securityGroupIds(List<String> securityGroupIds)

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

Security groups are supported only for interface endpoints.

Parameters:

securityGroupIds - The IDs of the security groups to associate with the endpoint network interface. This parameter is required.

Returns:

this

subnetIds

@Stability(value=Stable)
public CfnVPCEndpoint.Builder subnetIds(List<String> subnetIds)

The ID of the subnets in which to create an endpoint network interface.

You must specify this property for an interface endpoints 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.

Parameters:

subnetIds - The ID of the subnets in which to create an endpoint network interface. This parameter is required.

Returns:

this

vpcEndpointType

@Stability(value=Stable)
public CfnVPCEndpoint.Builder vpcEndpointType(String vpcEndpointType)

The type of endpoint.

Default: Gateway

Parameters:

vpcEndpointType - The type of endpoint. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnVPCEndpoint build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnVPCEndpoint>