software.amazon.awscdk.services.ec2

Class InterfaceVpcEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.InterfaceVpcEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<InterfaceVpcEndpoint>

Enclosing class:

InterfaceVpcEndpoint

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

A fluent builder for InterfaceVpcEndpoint.

Method Summary

Modifier and Type	Method and Description
InterfaceVpcEndpoint	build()
static InterfaceVpcEndpoint.Builder	create(software.constructs.Construct scope, String id)
InterfaceVpcEndpoint.Builder	lookupSupportedAzs(Boolean lookupSupportedAzs) Limit to only those availability zones where the endpoint service can be created.
InterfaceVpcEndpoint.Builder	open(Boolean open) Whether to automatically allow VPC traffic to the endpoint.
InterfaceVpcEndpoint.Builder	privateDnsEnabled(Boolean privateDnsEnabled) Whether to associate a private hosted zone with the specified VPC.
InterfaceVpcEndpoint.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) The security groups to associate with this interface VPC endpoint.
InterfaceVpcEndpoint.Builder	service(IInterfaceVpcEndpointService service) The service to use for this interface VPC endpoint.
InterfaceVpcEndpoint.Builder	subnets(SubnetSelection subnets) The subnets in which to create an endpoint network interface.
InterfaceVpcEndpoint.Builder	vpc(IVpc vpc) The VPC network in which the interface 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 InterfaceVpcEndpoint.Builder create(software.constructs.Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of InterfaceVpcEndpoint.Builder.

service

@Stability(value=Stable)
public InterfaceVpcEndpoint.Builder service(IInterfaceVpcEndpointService service)

The service to use for this interface VPC endpoint.

Parameters:

service - The service to use for this interface VPC endpoint. This parameter is required.

Returns:

this

lookupSupportedAzs

@Stability(value=Stable)
public InterfaceVpcEndpoint.Builder lookupSupportedAzs(Boolean lookupSupportedAzs)

Limit to only those availability zones where the endpoint service can be created.

Setting this to 'true' requires a lookup to be performed at synthesis time. Account and region must be set on the containing stack for this to work.

Default: false

Parameters:

lookupSupportedAzs - Limit to only those availability zones where the endpoint service can be created. This parameter is required.

Returns:

this

open

@Stability(value=Stable)
public InterfaceVpcEndpoint.Builder open(Boolean open)

Whether to automatically allow VPC traffic to the endpoint.

If enabled, all traffic to the endpoint from within the VPC will be automatically allowed. This is done based on the VPC's CIDR range.

Default: true

Parameters:

open - Whether to automatically allow VPC traffic to the endpoint. This parameter is required.

Returns:

this

privateDnsEnabled

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

Whether to associate a private hosted zone with the specified VPC.

This allows you to make requests to the service using its default DNS hostname.

Default: set by the instance of IInterfaceVpcEndpointService, or true if not defined by the instance of IInterfaceVpcEndpointService

Parameters:

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

Returns:

this

securityGroups

@Stability(value=Stable)
public InterfaceVpcEndpoint.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

The security groups to associate with this interface VPC endpoint.

Default: - a new security group is created

Parameters:

securityGroups - The security groups to associate with this interface VPC endpoint. This parameter is required.

Returns:

this

subnets

@Stability(value=Stable)
public InterfaceVpcEndpoint.Builder subnets(SubnetSelection subnets)

The subnets in which to create an endpoint network interface.

At most one per availability zone.

Default: - private subnets

Parameters:

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

Returns:

this

vpc

@Stability(value=Stable)
public InterfaceVpcEndpoint.Builder vpc(IVpc vpc)

The VPC network in which the interface endpoint will be used.

Parameters:

vpc - The VPC network in which the interface endpoint will be used. This parameter is required.

Returns:

this

build

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

Specified by:

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