vpc_endpoint_service_configurations

Creates, updates, deletes, gets or lists a vpc_endpoint_service_configurations resource.

Overview

Name	vpc_endpoint_service_configurations
Type	Resource
Id	aws.ec2.vpc_endpoint_service_configurations

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoint_service_configurations

Name	Datatype	Description
acceptance_required	boolean	Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
availability_zone_ids	string	The IDs of the Availability Zones in which the service is available. Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
availability_zones	string	The Availability Zones in which the service is available. Either AvailabilityZone or AvailabilityZoneId can be specified, but not both
base_endpoint_dns_names	string	The DNS names for the service.
gateway_load_balancer_arns	string	The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
manages_vpc_endpoints	boolean	Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
network_load_balancer_arns	string	The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
payer_responsibility	string	The payer responsibility.
private_dns_name	string	The private DNS name for the service.
private_dns_name_configuration	string	Information about the endpoint service private DNS name configuration.
remote_access_enabled	boolean	Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.
service_id	string	The ID of the service.
service_name	string	The name of the service.
service_state	string	The service state.
service_type	string	The type of service.
supported_ip_address_types	string	The supported IP address types.
supported_regions	string	The supported Regions.
tags	string	The tags assigned to the service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoint_service_configurations	select	region	DryRun, ServiceId, Filter, MaxResults, NextToken	Describes the VPC endpoint service configurations in your account (your services).
create_vpc_endpoint_service_configuration	insert	region	DryRun, AcceptanceRequired, PrivateDnsName, NetworkLoadBalancerArn, GatewayLoadBalancerArn, SupportedIpAddressType, SupportedRegion, ClientToken, TagSpecification	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.
modify_vpc_endpoint_service_configuration	update	ServiceId, region	DryRun, PrivateDnsName, RemovePrivateDnsName, AcceptanceRequired, AddNetworkLoadBalancerArn, RemoveNetworkLoadBalancerArn, AddGatewayLoadBalancerArn, RemoveGatewayLoadBalancerArn, AddSupportedIpAddressType, RemoveSupportedIpAddressType, AddSupportedRegion, RemoveSupportedRegion	Modifies the attributes of the specified VPC endpoint service configuration. If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
delete_vpc_endpoint_service_configurations	delete	ServiceId, region	DryRun	Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ServiceId	array	The IDs of the services.
region	string	AWS region (default: us-east-1)
AcceptanceRequired	boolean	Indicates whether requests to create an endpoint to the service must be accepted.
AddGatewayLoadBalancerArn	array	The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.
AddNetworkLoadBalancerArn	array	The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.
AddSupportedIpAddressType	array	The IP address types to add to the service configuration.
AddSupportedRegion	array	The supported Regions to add to the service configuration.
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
DryRun	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.
Filter	array	The filters. service-name - The name of the service. service-id - The ID of the service. service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed). supported-ip-address-types - The IP address type (ipv4 | ipv6). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
GatewayLoadBalancerArn	array	The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
MaxResults	integer	The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
NetworkLoadBalancerArn	array	The Amazon Resource Names (ARNs) of the Network Load Balancers.
NextToken	string	The token to retrieve the next page of results.
PrivateDnsName	string	(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
RemoveGatewayLoadBalancerArn	array	The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.
RemoveNetworkLoadBalancerArn	array	The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.
RemovePrivateDnsName	boolean	(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
RemoveSupportedIpAddressType	array	The IP address types to remove from the service configuration.
RemoveSupportedRegion	array	The supported Regions to remove from the service configuration.
ServiceId	array	The IDs of the endpoint services.
SupportedIpAddressType	array	The supported IP address types. The possible values are ipv4 and ipv6.
SupportedRegion	array	The Regions from which service consumers can access the service.
TagSpecification	array	The tags to associate with the service.

SELECT examples

describe_vpc_endpoint_service_configurations

Describes the VPC endpoint service configurations in your account (your services).

SELECT
acceptance_required,
availability_zone_ids,
availability_zones,
base_endpoint_dns_names,
gateway_load_balancer_arns,
manages_vpc_endpoints,
network_load_balancer_arns,
payer_responsibility,
private_dns_name,
private_dns_name_configuration,
remote_access_enabled,
service_id,
service_name,
service_state,
service_type,
supported_ip_address_types,
supported_regions,
tags
FROM aws.ec2.vpc_endpoint_service_configurations
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND ServiceId = '{{ ServiceId }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_vpc_endpoint_service_configuration

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.

INSERT INTO aws.ec2.vpc_endpoint_service_configurations (
region,
DryRun,
AcceptanceRequired,
PrivateDnsName,
NetworkLoadBalancerArn,
GatewayLoadBalancerArn,
SupportedIpAddressType,
SupportedRegion,
ClientToken,
TagSpecification
)
SELECT 
'{{ region }}',
'{{ DryRun }}',
'{{ AcceptanceRequired }}',
'{{ PrivateDnsName }}',
'{{ NetworkLoadBalancerArn }}',
'{{ GatewayLoadBalancerArn }}',
'{{ SupportedIpAddressType }}',
'{{ SupportedRegion }}',
'{{ ClientToken }}',
'{{ TagSpecification }}'
RETURNING
client_token,
service_configuration
;

Manifest

# Description fields are for documentation purposes
- name: vpc_endpoint_service_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vpc_endpoint_service_configurations resource.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.
  - name: AcceptanceRequired
    value: {{ AcceptanceRequired }}
    description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
    description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
  - name: PrivateDnsName
    value: "{{ PrivateDnsName }}"
    description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
    description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
  - name: NetworkLoadBalancerArn
    value: "{{ NetworkLoadBalancerArn }}"
    description: The Amazon Resource Names (ARNs) of the Network Load Balancers.
    description: The Amazon Resource Names (ARNs) of the Network Load Balancers.
  - name: GatewayLoadBalancerArn
    value: "{{ GatewayLoadBalancerArn }}"
    description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
    description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
  - name: SupportedIpAddressType
    value: "{{ SupportedIpAddressType }}"
    description: The supported IP address types. The possible values are ipv4 and ipv6.
    description: The supported IP address types. The possible values are ipv4 and ipv6.
  - name: SupportedRegion
    value: "{{ SupportedRegion }}"
    description: The Regions from which service consumers can access the service.
    description: The Regions from which service consumers can access the service.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to associate with the service.
    description: The tags to associate with the service.

UPDATE examples

modify_vpc_endpoint_service_configuration

Modifies the attributes of the specified VPC endpoint service configuration. If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

UPDATE aws.ec2.vpc_endpoint_service_configurations
SET 
-- No updatable properties
WHERE 
ServiceId = '{{ ServiceId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND PrivateDnsName = '{{ PrivateDnsName}}'
AND RemovePrivateDnsName = {{ RemovePrivateDnsName}}
AND AcceptanceRequired = {{ AcceptanceRequired}}
AND AddNetworkLoadBalancerArn = '{{ AddNetworkLoadBalancerArn}}'
AND RemoveNetworkLoadBalancerArn = '{{ RemoveNetworkLoadBalancerArn}}'
AND AddGatewayLoadBalancerArn = '{{ AddGatewayLoadBalancerArn}}'
AND RemoveGatewayLoadBalancerArn = '{{ RemoveGatewayLoadBalancerArn}}'
AND AddSupportedIpAddressType = '{{ AddSupportedIpAddressType}}'
AND RemoveSupportedIpAddressType = '{{ RemoveSupportedIpAddressType}}'
AND AddSupportedRegion = '{{ AddSupportedRegion}}'
AND RemoveSupportedRegion = '{{ RemoveSupportedRegion}}'
RETURNING
return;

DELETE examples

delete_vpc_endpoint_service_configurations

Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

DELETE FROM aws.ec2.vpc_endpoint_service_configurations
WHERE ServiceId = '{{ ServiceId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;