Package software.amazon.awscdk.services.ec2

Class CfnVPCEndpointService

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnVPCEndpointService
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.165Z") @Stability(Stable) public class CfnVPCEndpointService extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::VPCEndpointService.

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")
         .build();

  • 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 Construct scope, @NotNull String id, @Nullable CfnVPCEndpointServiceProps props)
      Create a new AWS::EC2::VPCEndpointService.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnVPCEndpointService

      @Stability(Stable) public CfnVPCEndpointService(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::EC2::VPCEndpointService.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getAcceptanceRequired

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

    • 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 .

    • 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.

      The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.

    • setPayerResponsibility

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

      The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.