pipeline_endpoint_connections

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

Overview

Name	pipeline_endpoint_connections
Type	Resource
Id	aws.osis.pipeline_endpoint_connections

Fields

The following fields are returned by SELECT queries:

list_pipeline_endpoint_connections

Name	Datatype	Description
endpoint_id	string	The unique identifier of the endpoint in the connection. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]+$</code>)
pipeline_arn	string	The Amazon Resource Name (ARN) of the pipeline in the endpoint connection. (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 connection. (CREATING, ACTIVE, CREATE_FAILED, DELETING, REVOKING, REVOKED)
vpc_endpoint_owner	string	The Amazon Web Services account ID that owns the VPC endpoint used in this connection. (pattern: <code>^\d{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_pipeline_endpoint_connections	select	region	maxResults, nextToken	Lists the pipeline endpoints connected to pipelines in your account.
revoke_pipeline_endpoint_connections	update	region, PipelineArn, EndpointIds		Revokes pipeline endpoints from specified endpoint IDs.

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

SELECT examples

list_pipeline_endpoint_connections

Lists the pipeline endpoints connected to pipelines in your account.

SELECT
endpoint_id,
pipeline_arn,
status,
vpc_endpoint_owner
FROM aws.osis.pipeline_endpoint_connections
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

revoke_pipeline_endpoint_connections

Revokes pipeline endpoints from specified endpoint IDs.

UPDATE aws.osis.pipeline_endpoint_connections
SET 
PipelineArn = '{{ PipelineArn }}',
EndpointIds = '{{ EndpointIds }}'
WHERE 
region = '{{ region }}' --required
AND PipelineArn = '{{ PipelineArn }}' --required
AND EndpointIds = '{{ EndpointIds }}' --required
RETURNING
pipeline_arn;