pipeline_tags

Expands all tag keys and values for pipelines in a region

Overview

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

Fields

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.
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
tag_key	string	Tag key.
tag_value	string	Tag value.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Expands tags for all pipelines in a region.

SELECT
region,
buffer_options,
encryption_at_rest_options,
log_publishing_options,
max_units,
min_units,
pipeline_configuration_body,
pipeline_name,
vpc_options,
vpc_endpoints,
pipeline_arn,
ingest_endpoint_urls,
tag_key,
tag_value
FROM aws.osis.pipeline_tags
WHERE region = 'us-east-1';

Permissions

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