pipeline_blueprints

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

Overview

Name	pipeline_blueprints
Type	Resource
Id	aws.osis.pipeline_blueprints

Fields

The following fields are returned by SELECT queries:

get_pipeline_blueprint

Name	Datatype	Description
blueprint	object	The requested blueprint in YAML format.
format	string	The format of the blueprint.

list_pipeline_blueprints

Name	Datatype	Description
blueprints	array	A list of available blueprints for Data Prepper.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pipeline_blueprint	select	blueprint_name, region	format	Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
list_pipeline_blueprints	select	region		Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a 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
blueprint_name	string	The name of the blueprint to retrieve.
region	string	AWS region (default: us-east-1)
format	string	The format format of the blueprint to retrieve.

SELECT examples

get_pipeline_blueprint

Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.

SELECT
blueprint,
format
FROM aws.osis.pipeline_blueprints
WHERE blueprint_name = '{{ blueprint_name }}' -- required
AND region = '{{ region }}' -- required
AND format = '{{ format }}'
;

list_pipeline_blueprints

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

SELECT
blueprints
FROM aws.osis.pipeline_blueprints
WHERE region = '{{ region }}' -- required
;