Package software.amazon.awscdk.services.ec2

Class CfnVPCEndpointService

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnVPCEndpointService
All Implemented Interfaces:
IInspectable, ITaggableV2, IVPCEndpointServiceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:36.527Z") @Stability(Stable) public class CfnVPCEndpointService extends CfnResource implements IInspectable, IVPCEndpointServiceRef, ITaggableV2
Creates a VPC endpoint service configuration to which service consumers ( AWS accounts, users, and IAM roles) can connect.

To create an endpoint service configuration, you must first create one of the following for your service:

For more information, see the AWS PrivateLink User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnVPCEndpointService cfnVPCEndpointService = CfnVPCEndpointService.Builder.create(this, "MyCfnVPCEndpointService")
         .acceptanceRequired(false)
         .contributorInsightsEnabled(false)
         .gatewayLoadBalancerArns(List.of("gatewayLoadBalancerArns"))
         .networkLoadBalancerArns(List.of("networkLoadBalancerArns"))
         .payerResponsibility("payerResponsibility")
         .supportedIpAddressTypes(List.of("supportedIpAddressTypes"))
         .supportedRegions(List.of("supportedRegions"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVPCEndpointService

      protected CfnVPCEndpointService(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVPCEndpointService

      protected CfnVPCEndpointService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVPCEndpointService

      @Stability(Stable) public CfnVPCEndpointService(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnVPCEndpointServiceProps props)
      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.
      props - Resource properties.

    • CfnVPCEndpointService

      @Stability(Stable) public CfnVPCEndpointService(@NotNull software.constructs.Construct scope, @NotNull 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.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrServiceId

      @Stability(Stable) @NotNull public String getAttrServiceId()
      The ID of the endpoint service.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getVpcEndpointServiceRef

      @Stability(Stable) @NotNull public VPCEndpointServiceReference getVpcEndpointServiceRef()
      A reference to a VPCEndpointService resource.
      Specified by:
      getVpcEndpointServiceRef in interface IVPCEndpointServiceRef

    • getAcceptanceRequired

      @Stability(Stable) @Nullable public Object getAcceptanceRequired()
      Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

      Returns union: either Boolean or IResolvable

    • setAcceptanceRequired

      @Stability(Stable) public void setAcceptanceRequired(@Nullable Boolean value)
      Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

    • setAcceptanceRequired

      @Stability(Stable) public void setAcceptanceRequired(@Nullable IResolvable value)
      Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

    • getContributorInsightsEnabled

      @Stability(Stable) @Nullable public Object getContributorInsightsEnabled()
      Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .

      Returns union: either Boolean or IResolvable

    • setContributorInsightsEnabled

      @Stability(Stable) public void setContributorInsightsEnabled(@Nullable Boolean value)
      Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .

    • setContributorInsightsEnabled

      @Stability(Stable) public void setContributorInsightsEnabled(@Nullable IResolvable value)
      Indicates whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink .

    • getGatewayLoadBalancerArns

      @Stability(Stable) @Nullable public List<String> getGatewayLoadBalancerArns()
      The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

    • setGatewayLoadBalancerArns

      @Stability(Stable) public void setGatewayLoadBalancerArns(@Nullable List<String> value)
      The Amazon Resource Names (ARNs) of the Gateway Load Balancers.

    • getNetworkLoadBalancerArns

      @Stability(Stable) @Nullable public List<String> getNetworkLoadBalancerArns()
      The Amazon Resource Names (ARNs) of the Network Load Balancers.

    • setNetworkLoadBalancerArns

      @Stability(Stable) public void setNetworkLoadBalancerArns(@Nullable List<String> value)
      The Amazon Resource Names (ARNs) of the Network Load Balancers.

    • getPayerResponsibility

      @Stability(Stable) @Nullable public String getPayerResponsibility()
      The entity that is responsible for the endpoint costs.

    • setPayerResponsibility

      @Stability(Stable) public void setPayerResponsibility(@Nullable String value)
      The entity that is responsible for the endpoint costs.

    • getSupportedIpAddressTypes

      @Stability(Stable) @Nullable public List<String> getSupportedIpAddressTypes()
      The supported IP address types.

    • setSupportedIpAddressTypes

      @Stability(Stable) public void setSupportedIpAddressTypes(@Nullable List<String> value)
      The supported IP address types.

    • getSupportedRegions

      @Stability(Stable) @Nullable public List<String> getSupportedRegions()
      The Regions from which service consumers can access the service.

    • setSupportedRegions

      @Stability(Stable) public void setSupportedRegions(@Nullable List<String> value)
      The Regions from which service consumers can access the service.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to associate with the service.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to associate with the service.