Syntax Properties Return values See also

AWS::EC2::VPCEndpointService

Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.

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

A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.

For more information, see the AWS PrivateLink User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::EC2::VPCEndpointService",
  "Properties" : {
      "AcceptanceRequired" : Boolean,
      "GatewayLoadBalancerArns" : [ String, ... ],
      "NetworkLoadBalancerArns" : [ String, ... ],
      "PayerResponsibility" : String
    }
}

YAML


Type: AWS::EC2::VPCEndpointService
Properties: 
  AcceptanceRequired: Boolean
  GatewayLoadBalancerArns: 
    - String
  NetworkLoadBalancerArns: 
    - String
  PayerResponsibility: String

Properties

AcceptanceRequired

Indicates whether requests from service consumers to create an endpoint to your service must be accepted.

Required: No

Type: Boolean

Update requires: No interruption

GatewayLoadBalancerArns

The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.

Required: No

Type: List of String

Update requires: No interruption

NetworkLoadBalancerArns

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

Required: No

Type: List of String

Update requires: No interruption

PayerResponsibility

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.

Required: No

Type: String

Allowed values: ServiceOwner

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the VPC endpoint service configuration.

For more information about using the Ref function, see Ref.