Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CreateVpcEndpointServiceConfiguration

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

To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AcceptanceRequired

Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.

Type: Boolean

Required: No

ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

NetworkLoadBalancerArn.N

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

Type: Array of strings

Required: Yes

Response Elements

The following elements are returned by the service.

clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

Type: String

requestId

The ID of the request.

Type: String

serviceConfiguration

Information about the service configuration.

Type: ServiceConfiguration object

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example creates a VPC endpoint service configuration using the load balancer my-nlb. This example also specifies that requests to connect to the service through a VPC endpoint must be accepted.

Sample Request

https://ec2.amazonaws.com/?Action=CreateVpcEndpointServiceConfiguration
&NetworkLoadBalancerArn.1=arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-nlb/e94221227f1ba532
&AcceptanceRequired=true
&AUTHPARAMS

Sample Response

<CreateVpcEndpointServiceConfigurationResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>1b2f25d4-9d9f-4256-a8e3-297f7example</requestId>
    <serviceConfiguration>
        <serviceState>Available</serviceState>
        <serviceType>
            <item>
                <serviceType>Interface</serviceType>
            </item>
        </serviceType>
        <baseEndpointDnsNameSet>
            <item>vpce-svc-0552b9c1298c4f123.us-east-1.vpce.amazonaws.com</item>
        </baseEndpointDnsNameSet>
        <acceptanceRequired>true</acceptanceRequired>
        <availabilityZoneSet>
            <item>us-east-1d</item>
        </availabilityZoneSet>
        <serviceId>vpce-svc-0552b9c1298c4f123</serviceId>
        <serviceName>com.amazonaws.vpce.us-east-1.vpce-svc-0552b9c1298c4f123</serviceName>
        <networkLoadBalancerArnSet>
            <item>arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-nlb/e94221227f1ba532</item>
        </networkLoadBalancerArnSet>
    </serviceConfiguration>
</CreateVpcEndpointServiceConfigurationResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: