pipeline_definitions

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

Overview

Name	pipeline_definitions
Type	Resource
Id	aws.datapipeline.pipeline_definitions

Fields

The following fields are returned by SELECT queries:

get_pipeline_definition

Name	Datatype	Description
parameter_objects	array	The parameter objects used in the pipeline definition.
parameter_values	array	The parameter values used in the pipeline definition.
pipeline_objects	array	The objects defined in the pipeline.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pipeline_definition	select	region		Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.
put_pipeline_definition	replace	region, pipelineId, pipelineObjects		Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

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)

SELECT examples

get_pipeline_definition

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

SELECT
parameter_objects,
parameter_values,
pipeline_objects
FROM aws.datapipeline.pipeline_definitions
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_pipeline_definition

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

REPLACE aws.datapipeline.pipeline_definitions
SET 
pipelineId = '{{ pipelineId }}',
pipelineObjects = '{{ pipelineObjects }}',
parameterObjects = '{{ parameterObjects }}',
parameterValues = '{{ parameterValues }}'
WHERE 
region = '{{ region }}' --required
AND pipelineId = '{{ pipelineId }}' --required
AND pipelineObjects = '{{ pipelineObjects }}' --required
RETURNING
errored,
validation_errors,
validation_warnings;