endpoints

Creates, updates, deletes or gets an endpoint resource or lists endpoints in a region

Overview

Name	endpoints
Type	Resource
Description	Resource Type Definition for AWS::S3Outposts::Endpoint
Id	aws.s3outposts.endpoints

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the endpoint.
cidr_block	string	The VPC CIDR committed by this endpoint.
creation_time	string	The time the endpoint was created.
id	string	The ID of the endpoint.
network_interfaces	array	The network interfaces of the endpoint.
outpost_id	string	The id of the customer outpost on which the bucket resides.
security_group_id	string	The ID of the security group to use with the endpoint.
status	string
subnet_id	string	The ID of the subnet in the selected VPC. The subnet must belong to the Outpost.
access_type	string	The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool.
customer_owned_ipv4_pool	string	The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint.
failed_reason	object	The failure reason, if any, for a create or delete endpoint operation.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	OutpostId, SecurityGroupId, SubnetId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all endpoints in a region.

SELECT
region,
arn,
cidr_block,
creation_time,
id,
network_interfaces,
outpost_id,
security_group_id,
status,
subnet_id,
access_type,
customer_owned_ipv4_pool,
failed_reason
FROM aws.s3outposts.endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual endpoint.

SELECT
region,
arn,
cidr_block,
creation_time,
id,
network_interfaces,
outpost_id,
security_group_id,
status,
subnet_id,
access_type,
customer_owned_ipv4_pool,
failed_reason
FROM aws.s3outposts.endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.s3outposts.endpoints (
 OutpostId,
 SecurityGroupId,
 SubnetId,
 region
)
SELECT 
'{{ OutpostId }}',
 '{{ SecurityGroupId }}',
 '{{ SubnetId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.s3outposts.endpoints (
 OutpostId,
 SecurityGroupId,
 SubnetId,
 AccessType,
 CustomerOwnedIpv4Pool,
 FailedReason,
 region
)
SELECT 
 '{{ OutpostId }}',
 '{{ SecurityGroupId }}',
 '{{ SubnetId }}',
 '{{ AccessType }}',
 '{{ CustomerOwnedIpv4Pool }}',
 '{{ FailedReason }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: endpoint
    props:
      - name: OutpostId
        value: '{{ OutpostId }}'
      - name: SecurityGroupId
        value: '{{ SecurityGroupId }}'
      - name: SubnetId
        value: '{{ SubnetId }}'
      - name: AccessType
        value: '{{ AccessType }}'
      - name: CustomerOwnedIpv4Pool
        value: '{{ CustomerOwnedIpv4Pool }}'
      - name: FailedReason
        value:
          ErrorCode: '{{ ErrorCode }}'
          Message: '{{ Message }}'

DELETE example

/*+ delete */
DELETE FROM aws.s3outposts.endpoints
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

s3-outposts:CreateEndpoint

Read

s3-outposts:ListEndpoints

Delete

s3-outposts:DeleteEndpoint

List

s3-outposts:ListEndpoints