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	awscc.s3outposts.endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the endpoint.
region	string	AWS region.

For more information, see AWS::S3Outposts::Endpoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	endpoints	INSERT	OutpostId, SecurityGroupId, SubnetId, region
delete_resource	endpoints	DELETE	Identifier, region
list_resources	endpoints_list_only	SELECT	region
get_resource	endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.s3outposts.endpoints
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all endpoints in a region.

SELECT
  region,
  arn
FROM awscc.s3outposts.endpoints_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.s3outposts.endpoints (
  OutpostId,
  SecurityGroupId,
  SubnetId,
  region
)
SELECT
  '{{ outpost_id }}',
  '{{ security_group_id }}',
  '{{ subnet_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3outposts.endpoints (
  OutpostId,
  SecurityGroupId,
  SubnetId,
  AccessType,
  CustomerOwnedIpv4Pool,
  FailedReason,
  region
)
SELECT
  '{{ outpost_id }}',
  '{{ security_group_id }}',
  '{{ subnet_id }}',
  '{{ access_type }}',
  '{{ customer_owned_ipv4_pool }}',
  '{{ failed_reason }}',
  '{{ 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: endpoint
  props:
    - name: outpost_id
      value: '{{ outpost_id }}'
    - name: security_group_id
      value: '{{ security_group_id }}'
    - name: subnet_id
      value: '{{ subnet_id }}'
    - name: access_type
      value: '{{ access_type }}'
    - name: customer_owned_ipv4_pool
      value: '{{ customer_owned_ipv4_pool }}'
    - name: failed_reason
      value:
        error_code: '{{ error_code }}'
        message: '{{ message }}'

DELETE example

/*+ delete */
DELETE FROM awscc.s3outposts.endpoints
WHERE
  Identifier = '{{ arn }}' 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 endpoints resource, the following permissions are required:

Create

s3-outposts:CreateEndpoint

Read

s3-outposts:ListEndpoints

Delete

s3-outposts:DeleteEndpoint

List

s3-outposts:ListEndpoints