software.amazon.awscdk.services.ec2

Class VpcEndpointService.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.VpcEndpointService.Builder

Enclosing class:

VpcEndpointService

public static final class VpcEndpointService.Builder
extends java.lang.Object

A fluent builder for VpcEndpointService.

Method Summary

Modifier and Type	Method and Description
VpcEndpointService.Builder	acceptanceRequired(java.lang.Boolean acceptanceRequired) Whether requests from service consumers to connect to the service through an endpoint must be accepted.
VpcEndpointService.Builder	allowedPrincipals(java.util.List<? extends ArnPrincipal> allowedPrincipals) IAM users, IAM roles, or AWS accounts to allow inbound connections from.
VpcEndpointService	build()
static VpcEndpointService.Builder	create(software.constructs.Construct scope, java.lang.String id)
VpcEndpointService.Builder	vpcEndpointServiceLoadBalancers(java.util.List<? extends IVpcEndpointServiceLoadBalancer> vpcEndpointServiceLoadBalancers) One or more load balancers to host the VPC Endpoint Service.
VpcEndpointService.Builder	vpcEndpointServiceName(java.lang.String vpcEndpointServiceName) Deprecated. This property is not used
VpcEndpointService.Builder	whitelistedPrincipals(java.util.List<? extends ArnPrincipal> whitelistedPrincipals) Deprecated. use `allowedPrincipals`

Methods inherited from class java.lang.Object

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

Method Detail

create

public static VpcEndpointService.Builder create(software.constructs.Construct scope,
                                                java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of VpcEndpointService.Builder.

vpcEndpointServiceLoadBalancers

public VpcEndpointService.Builder vpcEndpointServiceLoadBalancers(java.util.List<? extends IVpcEndpointServiceLoadBalancer> vpcEndpointServiceLoadBalancers)

One or more load balancers to host the VPC Endpoint Service.

Parameters:

vpcEndpointServiceLoadBalancers - One or more load balancers to host the VPC Endpoint Service. This parameter is required.

Returns:

this

acceptanceRequired

public VpcEndpointService.Builder acceptanceRequired(java.lang.Boolean acceptanceRequired)

Whether requests from service consumers to connect to the service through an endpoint must be accepted.

Default: true

Parameters:

acceptanceRequired - Whether requests from service consumers to connect to the service through an endpoint must be accepted. This parameter is required.

Returns:

this

allowedPrincipals

public VpcEndpointService.Builder allowedPrincipals(java.util.List<? extends ArnPrincipal> allowedPrincipals)

IAM users, IAM roles, or AWS accounts to allow inbound connections from.

These principals can connect to your service using VPC endpoints. Takes a list of one or more ArnPrincipal.

Default: - no principals

Parameters:

allowedPrincipals - IAM users, IAM roles, or AWS accounts to allow inbound connections from. This parameter is required.

Returns:

this

vpcEndpointServiceName

@Deprecated
public VpcEndpointService.Builder vpcEndpointServiceName(java.lang.String vpcEndpointServiceName)

Deprecated. This property is not used

(deprecated) Name of the Vpc Endpoint Service.

Default: - CDK generated name

Parameters:

vpcEndpointServiceName - Name of the Vpc Endpoint Service. This parameter is required.

Returns:

this

whitelistedPrincipals

@Deprecated
public VpcEndpointService.Builder whitelistedPrincipals(java.util.List<? extends ArnPrincipal> whitelistedPrincipals)

Deprecated. use `allowedPrincipals`

(deprecated) IAM users, IAM roles, or AWS accounts to allow inbound connections from.

These principals can connect to your service using VPC endpoints. Takes a list of one or more ArnPrincipal.

Default: - no principals

Parameters:

whitelistedPrincipals - IAM users, IAM roles, or AWS accounts to allow inbound connections from. This parameter is required.

Returns:

this

build

public VpcEndpointService build()