instance_connect_endpoints

Creates, updates, deletes or gets an instance_connect_endpoint resource or lists instance_connect_endpoints in a region

Overview

Name	instance_connect_endpoints
Type	Resource
Description	Resource Type definition for AWS::EC2::InstanceConnectEndpoint
Id	aws.ec2.instance_connect_endpoints

Fields

Name	Datatype	Description
id	string	The id of the instance connect endpoint
subnet_id	string	The subnet id of the instance connect endpoint
client_token	string	The client token of the instance connect endpoint.
preserve_client_ip	boolean	If true, the address of the instance connect endpoint client is preserved when connecting to the end resource
tags	array	The tags of the instance connect endpoint.
security_group_ids	array	The security group IDs of the instance connect endpoint.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SubnetId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all instance_connect_endpoints in a region.

SELECT
region,
id,
subnet_id,
client_token,
preserve_client_ip,
tags,
security_group_ids
FROM aws.ec2.instance_connect_endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual instance_connect_endpoint.

SELECT
region,
id,
subnet_id,
client_token,
preserve_client_ip,
tags,
security_group_ids
FROM aws.ec2.instance_connect_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ec2.instance_connect_endpoints (
 SubnetId,
 region
)
SELECT 
'{{ SubnetId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.instance_connect_endpoints (
 SubnetId,
 ClientToken,
 PreserveClientIp,
 Tags,
 SecurityGroupIds,
 region
)
SELECT 
 '{{ SubnetId }}',
 '{{ ClientToken }}',
 '{{ PreserveClientIp }}',
 '{{ Tags }}',
 '{{ SecurityGroupIds }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: instance_connect_endpoint
    props:
      - name: SubnetId
        value: '{{ SubnetId }}'
      - name: ClientToken
        value: '{{ ClientToken }}'
      - name: PreserveClientIp
        value: '{{ PreserveClientIp }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.instance_connect_endpoints
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateInstanceConnectEndpoint,
ec2:DescribeInstanceConnectEndpoints,
ec2:CreateTags,
ec2:CreateNetworkInterface,
iam:CreateServiceLinkedRole

Read

ec2:DescribeInstanceConnectEndpoints

Update

ec2:DescribeInstanceConnectEndpoints,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteInstanceConnectEndpoint,
ec2:DescribeInstanceConnectEndpoints

List

ec2:DescribeInstanceConnectEndpoints