Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect¶

Description¶

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.

Before you create an endpoint service, you must 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.

If you set the private DNS name, you must prove that you own the private DNS domain name.

For more information, see the Amazon Web Services PrivateLink Guide.

Usage¶

ec2_create_vpc_endpoint_service_configuration(DryRun,
  AcceptanceRequired, PrivateDnsName, NetworkLoadBalancerArns,
  GatewayLoadBalancerArns, SupportedIpAddressTypes, SupportedRegions,
  ClientToken, TagSpecifications)

Arguments¶

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

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

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

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

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

The supported IP address types. The possible values are ipv4 and ipv6.
SupportedRegions

The Regions from which service consumers can access the service.
ClientToken

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

The tags to associate with the service.

Value¶

A list with the following syntax:

list(
  ServiceConfiguration = list(
    ServiceType = list(
      list(
        ServiceType = "Interface"|"Gateway"|"GatewayLoadBalancer"
      )
    ),
    ServiceId = "string",
    ServiceName = "string",
    ServiceState = "Pending"|"Available"|"Deleting"|"Deleted"|"Failed",
    AvailabilityZoneIds = list(
      "string"
    ),
    AvailabilityZones = list(
      "string"
    ),
    AcceptanceRequired = TRUE|FALSE,
    ManagesVpcEndpoints = TRUE|FALSE,
    NetworkLoadBalancerArns = list(
      "string"
    ),
    GatewayLoadBalancerArns = list(
      "string"
    ),
    SupportedIpAddressTypes = list(
      "ipv4"|"ipv6"
    ),
    BaseEndpointDnsNames = list(
      "string"
    ),
    PrivateDnsName = "string",
    PrivateDnsNameConfiguration = list(
      State = "pendingVerification"|"verified"|"failed",
      Type = "string",
      Value = "string",
      Name = "string"
    ),
    PayerResponsibility = "ServiceOwner",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    SupportedRegions = list(
      list(
        Region = "string",
        ServiceState = "string"
      )
    ),
    RemoteAccessEnabled = TRUE|FALSE
  ),
  ClientToken = "string"
)

Request syntax¶

svc$create_vpc_endpoint_service_configuration(
  DryRun = TRUE|FALSE,
  AcceptanceRequired = TRUE|FALSE,
  PrivateDnsName = "string",
  NetworkLoadBalancerArns = list(
    "string"
  ),
  GatewayLoadBalancerArns = list(
    "string"
  ),
  SupportedIpAddressTypes = list(
    "string"
  ),
  SupportedRegions = list(
    "string"
  ),
  ClientToken = "string",
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"image-usage-report"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-metering-policy"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"vpc-encryption-control"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"capacity-block"|"mac-modification-task"|"ipam-prefix-list-resolver"|"ipam-policy"|"ipam-prefix-list-resolver-target"|"ipam-internet-registry-association"|"secondary-interface"|"secondary-network"|"secondary-subnet"|"capacity-manager-data-export"|"vpn-concentrator"|"ipam-pool-allocation"|"capacity-reservation-cancellation-quote"|"application-status-check"|"capacity-reservation-modification-quote",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)