Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-datapipeline-pipeline.json
Parent schema serverless-framework-configuration
Type: object

An example resource schema demonstrating some basic constructs and validation rules.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datapipeline

Properties

Name string | Aws_CF_FunctionString required

The name of the pipeline.

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 | Aws_CF_FunctionString

A description of the pipeline.

ParameterObjects ParameterObject[]

The parameter objects used with the pipeline.

ParameterValues ParameterValue[]

The parameter values used with the pipeline.

PipelineObjects PipelineObject[]

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.

PipelineTags PipelineTag[]

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.

Definitions

ParameterObject object
Attributes ParameterAttribute[] required

The attributes of the parameter object.

Id string | Aws_CF_FunctionString required

The ID of the parameter object.

ParameterAttribute object
Key string | Aws_CF_FunctionString required

The field identifier.

StringValue string | Aws_CF_FunctionString required

The field value, expressed as a String.

ParameterValue object
Id string | Aws_CF_FunctionString required

The ID of the parameter value.

StringValue string | Aws_CF_FunctionString required

The field value, expressed as a String.

Field object
Key string | Aws_CF_FunctionString required

Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide.

RefValue string | Aws_CF_FunctionString

A field value that you specify as an identifier of another object in the same pipeline definition.

StringValue string | Aws_CF_FunctionString

A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide.

PipelineObject object
Fields Field[] required

Key-value pairs that define the properties of the object.

Id string | Aws_CF_FunctionString required

The ID of the object.

Name string | Aws_CF_FunctionString required

The name of the object.

PipelineTag object
Key string | Aws_CF_FunctionString required

The key name of a tag.

Value string | Aws_CF_FunctionString required

The value to associate with the key name.