pipeline_endpoints

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

Overview

Name	pipeline_endpoints
Type	Resource
Id	aws.osis.pipeline_endpoints

Fields

The following fields are returned by SELECT queries:

list_pipeline_endpoints

Name	Datatype	Description
endpoint_id	string	The unique identifier for the pipeline endpoint. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]+$</code>)
ingest_endpoint_url	string	The URL used to ingest data to the pipeline through the VPC endpoint.
pipeline_arn	string	The Amazon Resource Name (ARN) of the pipeline associated with this endpoint. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):osis:.+:pipeline/.+$</code>)
status	string	The current status of the pipeline endpoint. (CREATING, ACTIVE, CREATE_FAILED, DELETING, REVOKING, REVOKED)
vpc_id	string	The ID of the VPC where the pipeline endpoint is created.
vpc_options	object	Configuration settings for the VPC endpoint, specifying network access controls.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_pipeline_endpoints	select	region	maxResults, nextToken	Lists all pipeline endpoints in your account.
create_pipeline_endpoint	insert	region, PipelineArn, VpcOptions		Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to.
delete_pipeline_endpoint	delete	endpoint_id, region		Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

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
endpoint_id	string	The unique identifier of the pipeline endpoint to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of pipeline endpoints to return in the response.
nextToken	string	If your initial ListPipelineEndpoints operation returns a NextToken, you can include the returned NextToken in subsequent ListPipelineEndpoints operations, which returns results in the next page.

SELECT examples

list_pipeline_endpoints

Lists all pipeline endpoints in your account.

SELECT
endpoint_id,
ingest_endpoint_url,
pipeline_arn,
status,
vpc_id,
vpc_options
FROM aws.osis.pipeline_endpoints
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_pipeline_endpoint

Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to.

INSERT INTO aws.osis.pipeline_endpoints (
PipelineArn,
VpcOptions,
region
)
SELECT 
'{{ PipelineArn }}' /* required */,
'{{ VpcOptions }}' /* required */,
'{{ region }}'
RETURNING
endpoint_id,
pipeline_arn,
status,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the pipeline_endpoints resource.
  - name: PipelineArn
    value: "{{ PipelineArn }}"
  - name: VpcOptions
    description: |
      Configuration settings for the VPC endpoint, specifying network access controls.
    value:
      SubnetIds:
        - "{{ SubnetIds }}"
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"

DELETE examples

delete_pipeline_endpoint

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

DELETE FROM aws.osis.pipeline_endpoints
WHERE endpoint_id = '{{ endpoint_id }}' --required
AND region = '{{ region }}' --required
;