pipeline

Gets an individual pipeline resource

Overview

Name	pipeline
Type	Resource
Description	pipeline
Id	awscc.osis.pipeline

Fields

Name	Datatype	Description
buffer_options	object
encryption_at_rest_options	object
log_publishing_options	object
max_units	integer	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
min_units	integer	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
pipeline_configuration_body	string	The Data Prepper pipeline configuration in YAML format.
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
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.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
buffer_options,
encryption_at_rest_options,
log_publishing_options,
max_units,
min_units,
pipeline_configuration_body,
pipeline_name,
tags,
vpc_options,
vpc_endpoints,
pipeline_arn,
ingest_endpoint_urls
FROM awscc.osis.pipeline
WHERE data__Identifier = '<PipelineArn>';

Permissions

To operate on the pipeline resource, the following permissions are required:

Read

osis:GetPipeline,
osis:ListTagsForResource

Update

osis:UpdatePipeline,
osis:GetPipeline,
osis:ListTagsForResource,
osis:TagResource,
osis:UntagResource,
iam:PassRole,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:ListLogDeliveries,
kms:DescribeKey

Delete

osis:DeletePipeline,
osis:GetPipeline,
logs:GetLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries