pipelines_list_only

Lists pipelines in a region or regions, for all properties use pipelines

Overview

Name	`pipelines_list_only`
Type	Resource
Description	An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
Id	`aws.osis.pipelines_list_only`

Name	Datatype	Description
`buffer_options`	`object`	Key-value pairs to configure buffering.
`encryption_at_rest_options`	`object`	Key-value pairs to configure encryption at rest.
`log_publishing_options`	`object`	Key-value pairs to configure log publishing.
`max_units`	`integer`	The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
`min_units`	`integer`	The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
`pipeline_configuration_body`	`string`	The Data Prepper pipeline configuration.
`pipeline_name`	`string`	Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
`tags`	`array`	An array of key-value pairs to apply to this resource.
`vpc_options`	`object`	Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.
`vpc_endpoints`	`array`	The VPC interface endpoints that have access to the pipeline.
`pipeline_arn`	`string`	The Amazon Resource Name (ARN) of the pipeline.
`ingest_endpoint_urls`	`array`	A list of endpoints that can be used for ingesting data into a pipeline
`region`	`string`	AWS region.

Name	Accessible by	Required Params
`list_resources`	`SELECT`	`region`

Lists all pipelines in a region.

SELECT
region,
pipeline_arn
FROM aws.osis.pipelines_list_only
WHERE region = 'us-east-1';

For permissions required to operate on the pipelines_list_only resource, see pipelines