create-vpc-endpoint-service-configuration¶

Description¶

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 VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide .

If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide .

Synopsis¶

  create-vpc-endpoint-service-configuration
[--dry-run | --no-dry-run]
[--acceptance-required | --no-acceptance-required]
[--private-dns-name <value>]
[--network-load-balancer-arns <value>]
[--gateway-load-balancer-arns <value>]
[--client-token <value>]
[--tag-specifications <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--dry-run | --no-dry-run (boolean)

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 .

--acceptance-required | --no-acceptance-required (boolean)

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

--private-dns-name (string)

(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.

--network-load-balancer-arns (list)

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

(string)

Syntax:

"string" "string" ...

--gateway-load-balancer-arns (list)

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

(string)

Syntax:

"string" "string" ...

--client-token (string)

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

--tag-specifications (list)

The tags to associate with the service.

(structure)

The tags to apply to a resource when the resource is being created.

ResourceType -> (string)

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group | snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway .

To tag a resource after it has been created, see CreateTags .

Tags -> (list)

The tags to apply to the resource.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"internet-gateway"|"key-pair"|"launch-template"|"local-gateway-route-table-vpc-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"placement-group"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Example 1: To create an endpoint service configuration for an interface endpoint

The following create-vpc-endpoint-service-configuration example creates a VPC endpoint service configuration using the Network Load Balancer nlb-vpce. This example also specifies that requests to connect to the service through an interface endpoint must be accepted.

aws ec2 create-vpc-endpoint-service-configuration \
    --network-load-balancer-arns arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532 \
    --acceptance-required

Output:

{
   "ServiceConfiguration": {
       "ServiceType": [
           {
               "ServiceType": "Interface"
           }
       ],
       "NetworkLoadBalancerArns": [
           "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532"
       ],
       "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-03d5ebb7d9579a2b3",
       "ServiceState": "Available",
       "ServiceId": "vpce-svc-03d5ebb7d9579a2b3",
       "AcceptanceRequired": true,
       "AvailabilityZones": [
           "us-east-1d"
       ],
       "BaseEndpointDnsNames": [
           "vpce-svc-03d5ebb7d9579a2b3.us-east-1.vpce.amazonaws.com"
       ]
   }
}

Example 2: To create an endpoint service configuration for a Gateway Load Balancer endpoint

The following create-vpc-endpoint-service-configuration example creates a VPC endpoint service configuration using the Gateway Load Balancer GWLBService. Requests to connect to the service through a Gateway Load Balancer endpoint are automatically accepted.

aws ec2 create-vpc-endpoint-service-configuration \
    --gateway-load-balancer-arns arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/123123123123abcc \
    --no-acceptance-required

Output:

{
    "ServiceConfiguration": {
        "ServiceType": [
            {
                "ServiceType": "GatewayLoadBalancer"
            }
        ],
        "ServiceId": "vpce-svc-123123a1c43abc123",
        "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-123123a1c43abc123",
        "ServiceState": "Available",
        "AvailabilityZones": [
            "us-east-1d"
        ],
        "AcceptanceRequired": false,
        "ManagesVpcEndpoints": false,
        "GatewayLoadBalancerArns": [
            "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/123123123123abcc"
        ]
    }
}

For more information, see VPC endpoint services in the Amazon VPC User Guide.

Output¶

ServiceConfiguration -> (structure)

Information about the service configuration.

ServiceType -> (list)

The type of service.

(structure)

Describes the type of service for a VPC endpoint.

ServiceType -> (string)

The type of service.

ServiceId -> (string)

The ID of the service.

ServiceName -> (string)

The name of the service.

ServiceState -> (string)

The service state.

AvailabilityZones -> (list)

The Availability Zones in which the service is available.

(string)

AcceptanceRequired -> (boolean)

Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.

ManagesVpcEndpoints -> (boolean)

Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

NetworkLoadBalancerArns -> (list)

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

(string)

GatewayLoadBalancerArns -> (list)

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

(string)

BaseEndpointDnsNames -> (list)

The DNS names for the service.

(string)

PrivateDnsName -> (string)

The private DNS name for the service.

PrivateDnsNameConfiguration -> (structure)

Information about the endpoint service private DNS name configuration.

State -> (string)

The verification state of the VPC endpoint service.

>Consumers of the endpoint service can use the private name only when the state is verified .

Type -> (string)

The endpoint service verification type, for example TXT.

Value -> (string)

The value the service provider adds to the private DNS name domain record before verification.

Name -> (string)

The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name .

Tags -> (list)

Any tags assigned to the service.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

ClientToken -> (string)

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

Table of Contents

Feedback

User Guide