endpoint

Gets an individual endpoint resource

Overview

Name	endpoint
Type	Resource
Description	endpoint
Id	awscc.s3outposts.endpoint

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

Currently only SELECT is supported for this resource resource.

Example

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.endpoint
WHERE data__Identifier = '<Arn>';

Permissions

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

Read

s3-outposts:ListEndpoints

Delete

s3-outposts:DeleteEndpoint