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	awscc.ec2.instance_connect_endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The id of the instance connect endpoint
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	instance_connect_endpoints	INSERT	SubnetId, region
delete_resource	instance_connect_endpoints	DELETE	Identifier, region
update_resource	instance_connect_endpoints	UPDATE	Identifier, PatchDocument, region
list_resources	instance_connect_endpoints_list_only	SELECT	region
get_resource	instance_connect_endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual instance_connect_endpoint.

SELECT
  region,
  id,
  subnet_id,
  client_token,
  preserve_client_ip,
  tags,
  security_group_ids
FROM awscc.ec2.instance_connect_endpoints
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all instance_connect_endpoints in a region.

SELECT
  region,
  id
FROM awscc.ec2.instance_connect_endpoints_list_only
WHERE
  region = 'us-east-1';

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 awscc.ec2.instance_connect_endpoints (
  SubnetId,
  region
)
SELECT
  '{{ subnet_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.instance_connect_endpoints (
  SubnetId,
  ClientToken,
  PreserveClientIp,
  Tags,
  SecurityGroupIds,
  region
)
SELECT
  '{{ subnet_id }}',
  '{{ client_token }}',
  '{{ preserve_client_ip }}',
  '{{ tags }}',
  '{{ security_group_ids }}',
  '{{ 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: subnet_id
        value: '{{ subnet_id }}'
      - name: client_token
        value: '{{ client_token }}'
      - name: preserve_client_ip
        value: '{{ preserve_client_ip }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: security_group_ids
        value:
          - '{{ security_group_ids[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.instance_connect_endpoints
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.instance_connect_endpoints
WHERE
  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