software.amazon.awscdk.services.ec2

Interface VpcEndpointServiceProps

All Known Implementing Classes:

VpcEndpointServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:38.597Z")
public interface VpcEndpointServiceProps

Construction properties for a VpcEndpointService.

Example:

 NetworkLoadBalancer networkLoadBalancer1;
 NetworkLoadBalancer networkLoadBalancer2;
 VpcEndpointService.Builder.create(this, "EndpointService")
         .vpcEndpointServiceLoadBalancers(List.of(networkLoadBalancer1, networkLoadBalancer2))
         .acceptanceRequired(true)
         .allowedPrincipals(List.of(new ArnPrincipal("arn:aws:iam::123456789012:root")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VpcEndpointServiceProps.Builder A builder for VpcEndpointServiceProps
static class	VpcEndpointServiceProps.Jsii$Proxy An implementation for VpcEndpointServiceProps

Method Summary

Modifier and Type	Method and Description
static VpcEndpointServiceProps.Builder	builder()
default java.lang.Boolean	getAcceptanceRequired() Whether requests from service consumers to connect to the service through an endpoint must be accepted.
default java.util.List<ArnPrincipal>	getAllowedPrincipals() IAM users, IAM roles, or AWS accounts to allow inbound connections from.
java.util.List<IVpcEndpointServiceLoadBalancer>	getVpcEndpointServiceLoadBalancers() One or more load balancers to host the VPC Endpoint Service.
default java.lang.String	getVpcEndpointServiceName() Deprecated. This property is not used
default java.util.List<ArnPrincipal>	getWhitelistedPrincipals() Deprecated. use `allowedPrincipals`

Method Detail

getVpcEndpointServiceLoadBalancers

java.util.List<IVpcEndpointServiceLoadBalancer> getVpcEndpointServiceLoadBalancers()

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

getAcceptanceRequired

default java.lang.Boolean getAcceptanceRequired()

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

Default: true

getAllowedPrincipals

default java.util.List<ArnPrincipal> getAllowedPrincipals()

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

getVpcEndpointServiceName

@Deprecated
default java.lang.String getVpcEndpointServiceName()

Deprecated. This property is not used

(deprecated) Name of the Vpc Endpoint Service.

Default: - CDK generated name

getWhitelistedPrincipals

@Deprecated
default java.util.List<ArnPrincipal> getWhitelistedPrincipals()

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

builder

static VpcEndpointServiceProps.Builder builder()

Returns:

a VpcEndpointServiceProps.Builder of VpcEndpointServiceProps