vpc_endpoint_services

Creates, updates, deletes or gets a vpc_endpoint_service resource or lists vpc_endpoint_services in a region

Overview

Name	vpc_endpoint_services
Type	Resource
Description	Resource Type definition for AWS::EC2::VPCEndpointService
Id	awscc.ec2.vpc_endpoint_services

Fields

get (all properties)

Name	Datatype	Description
network_load_balancer_arns	array
contributor_insights_enabled	boolean
payer_responsibility	string
service_id	string
acceptance_required	boolean
gateway_load_balancer_arns	array
▶tags	array	The tags to add to the VPC endpoint service.
supported_ip_address_types	array	Specify which Ip Address types are supported for VPC endpoint service.
supported_regions	array	The Regions from which service consumers can access the service.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
service_id	string
region	string	AWS region.

For more information, see AWS::EC2::VPCEndpointService.

Methods

Name	Resource	Accessible by	Required Params
create_resource	vpc_endpoint_services	INSERT	region
delete_resource	vpc_endpoint_services	DELETE	Identifier, region
update_resource	vpc_endpoint_services	UPDATE	Identifier, PatchDocument, region
list_resources	vpc_endpoint_services_list_only	SELECT	region
get_resource	vpc_endpoint_services	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual vpc_endpoint_service.

SELECT
  region,
  network_load_balancer_arns,
  contributor_insights_enabled,
  payer_responsibility,
  service_id,
  acceptance_required,
  gateway_load_balancer_arns,
  tags,
  supported_ip_address_types,
  supported_regions
FROM awscc.ec2.vpc_endpoint_services
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ service_id }}';

list (identifiers only)

Lists all vpc_endpoint_services in a region.

SELECT
  region,
  service_id
FROM awscc.ec2.vpc_endpoint_services_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new vpc_endpoint_service resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_endpoint_services (
  NetworkLoadBalancerArns,
  ContributorInsightsEnabled,
  PayerResponsibility,
  AcceptanceRequired,
  GatewayLoadBalancerArns,
  Tags,
  SupportedIpAddressTypes,
  SupportedRegions,
  region
)
SELECT
  '{{ network_load_balancer_arns }}',
  '{{ contributor_insights_enabled }}',
  '{{ payer_responsibility }}',
  '{{ acceptance_required }}',
  '{{ gateway_load_balancer_arns }}',
  '{{ tags }}',
  '{{ supported_ip_address_types }}',
  '{{ supported_regions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.vpc_endpoint_services (
  NetworkLoadBalancerArns,
  ContributorInsightsEnabled,
  PayerResponsibility,
  AcceptanceRequired,
  GatewayLoadBalancerArns,
  Tags,
  SupportedIpAddressTypes,
  SupportedRegions,
  region
)
SELECT
  '{{ network_load_balancer_arns }}',
  '{{ contributor_insights_enabled }}',
  '{{ payer_responsibility }}',
  '{{ acceptance_required }}',
  '{{ gateway_load_balancer_arns }}',
  '{{ tags }}',
  '{{ supported_ip_address_types }}',
  '{{ supported_regions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: vpc_endpoint_service
  props:
    - name: network_load_balancer_arns
      value:
        - '{{ network_load_balancer_arns[0] }}'
    - name: contributor_insights_enabled
      value: '{{ contributor_insights_enabled }}'
    - name: payer_responsibility
      value: '{{ payer_responsibility }}'
    - name: acceptance_required
      value: '{{ acceptance_required }}'
    - name: gateway_load_balancer_arns
      value:
        - '{{ gateway_load_balancer_arns[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: supported_ip_address_types
      value:
        - '{{ supported_ip_address_types[0] }}'
    - name: supported_regions
      value:
        - '{{ supported_regions[0] }}'

UPDATE example

Use the following StackQL query and manifest file to update a vpc_endpoint_service resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.vpc_endpoint_services
SET PatchDocument = string('{{ {
    "NetworkLoadBalancerArns": network_load_balancer_arns,
    "ContributorInsightsEnabled": contributor_insights_enabled,
    "PayerResponsibility": payer_responsibility,
    "AcceptanceRequired": acceptance_required,
    "GatewayLoadBalancerArns": gateway_load_balancer_arns,
    "Tags": tags,
    "SupportedIpAddressTypes": supported_ip_address_types,
    "SupportedRegions": supported_regions
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ service_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.vpc_endpoint_services
WHERE
  Identifier = '{{ service_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the vpc_endpoint_services resource, the following permissions are required:

Create

ec2:CreateVpcEndpointServiceConfiguration,
ec2:ModifyVpcEndpointServicePayerResponsibility,
cloudwatch:ListManagedInsightRules,
cloudwatch:DeleteInsightRules,
cloudwatch:PutManagedInsightRules,
ec2:DescribeVpcEndpointServiceConfigurations,
vpce:AllowMultiRegion,
ec2:CreateTags

Update

ec2:ModifyVpcEndpointServiceConfiguration,
ec2:DescribeVpcEndpointServiceConfigurations,
ec2:ModifyVpcEndpointServicePayerResponsibility,
cloudwatch:ListManagedInsightRules,
cloudwatch:DeleteInsightRules,
cloudwatch:PutManagedInsightRules,
ec2:CreateTags,
ec2:DeleteTags,
vpce:AllowMultiRegion

Read

ec2:DescribeVpcEndpointServiceConfigurations,
cloudwatch:ListManagedInsightRules

Delete

ec2:DeleteVpcEndpointServiceConfigurations,
ec2:DescribeVpcEndpointServiceConfigurations,
cloudwatch:ListManagedInsightRules,
cloudwatch:DeleteInsightRules,
ec2:DeleteTags,
vpce:AllowMultiRegion

List

ec2:DescribeVpcEndpointServiceConfigurations,
cloudwatch:ListManagedInsightRules