vpc_endpoint_services

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

Overview

Name	vpc_endpoint_services
Type	Resource
Id	aws.ec2.vpc_endpoint_services

Fields

The following fields are returned by SELECT queries:

describe_vpc_endpoint_services

Name	Datatype	Description
acceptance_required	boolean	Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
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.
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.
owner	string	The Amazon Web Services account ID of the service owner.
payer_responsibility	string	The payer responsibility.
private_dns_name	string	The private DNS name for the service.
private_dns_name_verification_state	string	The verification state of the VPC endpoint service. Consumers of the endpoint service cannot use the private name when the state is not verified.
private_dns_names	string	The private DNS names assigned to the VPC endpoint service.
service_id	string	The ID of the endpoint service.
service_name	string	The name of the service.
service_region	string	The Region where the service is hosted.
service_type	string	The type of service.
supported_ip_address_types	string	The supported IP address types.
tags	string	The tags assigned to the service.
vpc_endpoint_policy_supported	boolean	Indicates whether the service supports endpoint policies.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_vpc_endpoint_services	select	region	DryRun, ServiceName, Filter, MaxResults, NextToken, ServiceRegion	Describes available services to which you can create a VPC endpoint. When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.
modify_vpc_endpoint_service_payer_responsibility	update	ServiceId, PayerResponsibility, region	DryRun	Modifies the payer responsibility for your VPC endpoint service.
start_vpc_endpoint_service_private_dns_verification	exec	ServiceId, region	DryRun	Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service. The service provider must successfully perform the verification before the consumer can use the name to access the service. Before the service provider runs this command, they must add a record to the DNS server.

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
PayerResponsibility	string	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.
ServiceId	string	The ID of the endpoint service.
region	string	AWS region (default: us-east-1)
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. owner - The ID or alias of the Amazon Web Services account that owns the service. service-name - The name of the service. service-region - The Region of the service. service-type - The type of service (Interface | Gateway | GatewayLoadBalancer). 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.
MaxResults	integer	The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1,000, we return only 1,000 items.
NextToken	string	The token for the next set of items to return. (You received this token from a prior call.)
ServiceName	array	The service names.
ServiceRegion	array	The service Regions.

SELECT examples

describe_vpc_endpoint_services

Describes available services to which you can create a VPC endpoint. When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.

SELECT
acceptance_required,
availability_zone_ids,
availability_zones,
base_endpoint_dns_names,
manages_vpc_endpoints,
owner,
payer_responsibility,
private_dns_name,
private_dns_name_verification_state,
private_dns_names,
service_id,
service_name,
service_region,
service_type,
supported_ip_address_types,
tags,
vpc_endpoint_policy_supported
FROM aws.ec2.vpc_endpoint_services
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND ServiceName = '{{ ServiceName }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND ServiceRegion = '{{ ServiceRegion }}'
;

UPDATE examples

modify_vpc_endpoint_service_payer_responsibility

Modifies the payer responsibility for your VPC endpoint service.

UPDATE aws.ec2.vpc_endpoint_services
SET 
-- No updatable properties
WHERE 
ServiceId = '{{ ServiceId }}' --required
AND PayerResponsibility = '{{ PayerResponsibility }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
RETURNING
return_value;

Lifecycle Methods

start_vpc_endpoint_service_private_dns_verification

Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service. The service provider must successfully perform the verification before the consumer can use the name to access the service. Before the service provider runs this command, they must add a record to the DNS server.

EXEC aws.ec2.vpc_endpoint_services.start_vpc_endpoint_service_private_dns_verification 
@ServiceId='{{ ServiceId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;