shared_endpoints

Creates, updates, deletes, gets or lists a shared_endpoints resource.

Overview

Name	shared_endpoints
Type	Resource
Id	aws.s3outposts.shared_endpoints

Fields

The following fields are returned by SELECT queries:

list_shared_endpoints

Name	Datatype	Description
access_type	string	The type of connectivity used to access the Amazon S3 on Outposts endpoint. (Private, CustomerOwnedIp)
cidr_block	string	The VPC CIDR committed by this endpoint.
creation_time	string (date-time)	The time the endpoint was created.
customer_owned_ipv_4_pool	string	The ID of the customer-owned IPv4 address pool used for the endpoint. (pattern: <code>^ipv4pool-coip-([0-9a-f]{17})$</code>)
endpoint_arn	string	The Amazon Resource Name (ARN) of the endpoint. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|ec2)/endpoint/[a-zA-Z0-9]{19}$</code>)
failed_reason	object	The failure reason, if any, for a create or delete endpoint operation.
network_interfaces	array	The network interface of the endpoint.
outposts_id	string	The ID of the Outposts. (pattern: <code>^(op-[a-f0-9]{17}|\d{12}|ec2)$</code>)
security_group_id	string	The ID of the security group used for the endpoint. (pattern: <code>^sg-([0-9a-f]{8}|[0-9a-f]{17})$</code>)
status	string	The status of the endpoint. (Pending, Available, Deleting, Create_Failed, Delete_Failed)
subnet_id	string	The ID of the subnet used for the endpoint. (pattern: <code>^subnet-([0-9a-f]{8}|[0-9a-f]{17})$</code>)
vpc_id	string	The ID of the VPC used for the endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_shared_endpoints	select	outpostId, region	nextToken, maxResults	Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM). Related actions include: CreateEndpoint DeleteEndpoint

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
outpostId	string	The ID of the Amazon Web Services Outpost.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of endpoints that will be returned in the response.
nextToken	string	If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.

SELECT examples

list_shared_endpoints

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM). Related actions include: CreateEndpoint DeleteEndpoint

SELECT
access_type,
cidr_block,
creation_time,
customer_owned_ipv_4_pool,
endpoint_arn,
failed_reason,
network_interfaces,
outposts_id,
security_group_id,
status,
subnet_id,
vpc_id
FROM aws.s3outposts.shared_endpoints
WHERE outpostId = '{{ outpostId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;