Package software.amazon.awscdk.services.ec2

Interface VpcEndpointServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VpcEndpointServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.562Z")
@Stability(Stable)
public interface VpcEndpointServiceProps
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	VpcEndpointServiceProps.Builder	A builder for VpcEndpointServiceProps
static final class	VpcEndpointServiceProps.Jsii$Proxy	An implementation for VpcEndpointServiceProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVpcEndpointServiceLoadBalancers

@Stability(Stable)
@NotNull
List<IVpcEndpointServiceLoadBalancer> getVpcEndpointServiceLoadBalancers()

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

getAcceptanceRequired

@Stability(Stable)
@Nullable
default Boolean getAcceptanceRequired()

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

Default: true

getAllowedPrincipals

@Stability(Stable)
@Nullable
default 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

@Stability(Deprecated)
@Deprecated
@Nullable
default String getVpcEndpointServiceName()

Deprecated.

This property is not used

(deprecated) Name of the Vpc Endpoint Service.

Default: - CDK generated name

getWhitelistedPrincipals

@Stability(Deprecated)
@Deprecated
@Nullable
default 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

@Stability(Stable)
static VpcEndpointServiceProps.Builder builder()

Returns:

a VpcEndpointServiceProps.Builder of VpcEndpointServiceProps