private_graph_endpoints

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

Overview

Name	private_graph_endpoints
Type	Resource
Id	aws.neptune_graph.private_graph_endpoints

Fields

The following fields are returned by SELECT queries:

get_private_graph_endpoint

Name	Datatype	Description
status	string	The current status of the private endpoint. (CREATING, AVAILABLE, DELETING, FAILED)
subnet_ids	array	The subnet IDs involved.
vpc_endpoint_id	string	The ID of the private endpoint. (pattern: <code>vpce-[0-9a-f]{17}</code>)
vpc_id	string	The ID of the VPC where the private endpoint is located. (pattern: <code>vpc-[a-z0-9]+</code>)

list_private_graph_endpoints

Name	Datatype	Description
status	string	The status of the private graph endpoint. (CREATING, AVAILABLE, DELETING, FAILED)
subnet_ids	array	The subnet IDs associated with the private graph endpoint.
vpc_endpoint_id	string	The ID of the VPC endpoint. (pattern: <code>vpce-[0-9a-f]{17}</code>)
vpc_id	string	The ID of the VPC in which the private graph endpoint is located. (pattern: <code>vpc-[a-z0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_private_graph_endpoint	select	graph_identifier, vpc_id, region		Retrieves information about a specified private endpoint.
list_private_graph_endpoints	select	graph_identifier, region	nextToken, maxResults	Lists private endpoints for a specified Neptune Analytics graph.
create_private_graph_endpoint	insert	graph_identifier, region		Create a private graph endpoint to allow private access to the graph from within a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.
delete_private_graph_endpoint	delete	graph_identifier, vpc_id, region		Deletes a private graph endpoint.

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
graph_identifier	string	The unique identifier of the Neptune Analytics graph.
region	string	AWS region (default: us-east-1)
vpc_id	string	The ID of the VPC where the private endpoint is located.
maxResults	integer	The total number of records to return in the command's output. If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.
nextToken	string	Pagination token used to paginate output. When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

SELECT examples

get_private_graph_endpoint

Retrieves information about a specified private endpoint.

SELECT
status,
subnet_ids,
vpc_endpoint_id,
vpc_id
FROM aws.neptune_graph.private_graph_endpoints
WHERE graph_identifier = '{{ graph_identifier }}' -- required
AND vpc_id = '{{ vpc_id }}' -- required
AND region = '{{ region }}' -- required
;

list_private_graph_endpoints

Lists private endpoints for a specified Neptune Analytics graph.

SELECT
status,
subnet_ids,
vpc_endpoint_id,
vpc_id
FROM aws.neptune_graph.private_graph_endpoints
WHERE graph_identifier = '{{ graph_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_private_graph_endpoint

Create a private graph endpoint to allow private access to the graph from within a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.

INSERT INTO aws.neptune_graph.private_graph_endpoints (
vpcId,
subnetIds,
vpcSecurityGroupIds,
graph_identifier,
region
)
SELECT 
'{{ vpcId }}',
'{{ subnetIds }}',
'{{ vpcSecurityGroupIds }}',
'{{ graph_identifier }}',
'{{ region }}'
RETURNING
status,
subnet_ids,
vpc_endpoint_id,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: private_graph_endpoints
props:
  - name: graph_identifier
    value: "{{ graph_identifier }}"
    description: Required parameter for the private_graph_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the private_graph_endpoints resource.
  - name: vpcId
    value: "{{ vpcId }}"
  - name: subnetIds
    value:
      - "{{ subnetIds }}"
  - name: vpcSecurityGroupIds
    value:
      - "{{ vpcSecurityGroupIds }}"

DELETE examples

delete_private_graph_endpoint

Deletes a private graph endpoint.

DELETE FROM aws.neptune_graph.private_graph_endpoints
WHERE graph_identifier = '{{ graph_identifier }}' --required
AND vpc_id = '{{ vpc_id }}' --required
AND region = '{{ region }}' --required
;