Package 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(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	Description
CfnVPCEndpoint	build()
static CfnVPCEndpoint.Builder	create(software.constructs.Construct scope, String id)
CfnVPCEndpoint.Builder	dnsOptions(IResolvable dnsOptions)	Describes the DNS options for an endpoint.
CfnVPCEndpoint.Builder	dnsOptions(CfnVPCEndpoint.DnsOptionsSpecificationProperty dnsOptions)	Describes the DNS options for an endpoint.
CfnVPCEndpoint.Builder	ipAddressType(String ipAddressType)	The supported IP address types.
CfnVPCEndpoint.Builder	policyDocument(Object policyDocument)	An endpoint policy, which 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	resourceConfigurationArn(String resourceConfigurationArn)	The Amazon Resource Name (ARN) of the resource configuration.
CfnVPCEndpoint.Builder	routeTableIds(List<String> routeTableIds)	The IDs of the route tables.
CfnVPCEndpoint.Builder	securityGroupIds(List<String> securityGroupIds)	The IDs of the security groups to associate with the endpoint network interfaces.
CfnVPCEndpoint.Builder	serviceName(String serviceName)	The name of the endpoint service.
CfnVPCEndpoint.Builder	serviceNetworkArn(String serviceNetworkArn)	The Amazon Resource Name (ARN) of the service network.
CfnVPCEndpoint.Builder	subnetIds(List<String> subnetIds)	The IDs of the subnets in which to create endpoint network interfaces.
CfnVPCEndpoint.Builder	tags(List<? extends CfnTag> tags)
CfnVPCEndpoint.Builder	vpcEndpointType(String vpcEndpointType)	The type of endpoint.
CfnVPCEndpoint.Builder	vpcId(String vpcId)	The ID of the VPC.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnVPCEndpoint.Builder.

vpcId

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

The ID of the VPC.

Parameters:

vpcId - The ID of the VPC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcid

dnsOptions

@Stability(Stable)
public CfnVPCEndpoint.Builder dnsOptions(IResolvable dnsOptions)

Describes the DNS options for an endpoint.

Parameters:

dnsOptions - Describes the DNS options for an endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-dnsoptions

dnsOptions

@Stability(Stable)
public CfnVPCEndpoint.Builder dnsOptions(CfnVPCEndpoint.DnsOptionsSpecificationProperty dnsOptions)

Describes the DNS options for an endpoint.

Parameters:

dnsOptions - Describes the DNS options for an endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-dnsoptions

ipAddressType

@Stability(Stable)
public CfnVPCEndpoint.Builder ipAddressType(String ipAddressType)

The supported IP address types.

Parameters:

ipAddressType - The supported IP address types. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-ipaddresstype

policyDocument

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

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":"*" }] }'

Parameters:

policyDocument - An endpoint policy, which controls access to the service from the VPC. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-policydocument

privateDnsEnabled

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

privateDnsEnabled

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-privatednsenabled

resourceConfigurationArn

@Stability(Stable)
public CfnVPCEndpoint.Builder resourceConfigurationArn(String resourceConfigurationArn)

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

Parameters:

resourceConfigurationArn - The Amazon Resource Name (ARN) of the resource configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-resourceconfigurationarn

routeTableIds

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

The IDs of the route tables.

Routing is supported only for gateway endpoints.

Parameters:

routeTableIds - The IDs of the route tables. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-routetableids

securityGroupIds

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

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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-securitygroupids

serviceName

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

The name of the endpoint service.

Parameters:

serviceName - The name of the endpoint service. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicename

serviceNetworkArn

@Stability(Stable)
public CfnVPCEndpoint.Builder serviceNetworkArn(String serviceNetworkArn)

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

Parameters:

serviceNetworkArn - The Amazon Resource Name (ARN) of the service network. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-servicenetworkarn

subnetIds

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

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.

Parameters:

subnetIds - The IDs of the subnets in which to create endpoint network interfaces. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-subnetids

tags

@Stability(Stable)
public CfnVPCEndpoint.Builder tags(List<? extends CfnTag> tags)

Parameters:

tags - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-tags

vpcEndpointType

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcendpoint.html#cfn-ec2-vpcendpoint-vpcendpointtype

build

@Stability(Stable)
public CfnVPCEndpoint build()

Specified by:

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

Returns:

a newly built instance of CfnVPCEndpoint.