pipeline

Gets an individual pipeline resource

Overview

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

Fields

Name	Datatype	Description
activate	boolean	Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
description	string	A description of the pipeline.
name	string	The name of the pipeline.
parameter_objects	array	The parameter objects used with the pipeline.
parameter_values	array	The parameter values used with the pipeline.
pipeline_objects	array	The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
pipeline_tags	array	A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
pipeline_id	string
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
activate,
description,
name,
parameter_objects,
parameter_values,
pipeline_objects,
pipeline_tags,
pipeline_id
FROM awscc.datapipeline.pipeline
WHERE data__Identifier = '<PipelineId>';

Permissions

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

Read

datapipeline:GetPipelineDefinition,
datapipeline:DescribePipelines

Update

datapipeline:PutPipelineDefinition,
datapipeline:AddTags,
datapipeline:RemoveTags,
datapipeline:DeactivatePipeline,
datapipeline:GetPipelineDefinition,
datapipeline:ActivatePipeline,
datapipeline:ValidatePipelineDefinition,
datapipeline:DescribePipelines,
datapipeline:AddTags,
datapipeline:RemoveTags,
iam:PassRole

Delete

datapipeline:DeletePipeline,
datapipeline:DescribePipelines,
datapipeline:GetPipelineDefinition,
datapipeline:RemoveTags