- Valid Scope(s): Unknown
- alias: string (Required): the resource alias
- name: string: the resource name
- properties: AWS.DataPipeline/PipelineProperties (Required): properties of the resource
- Activate: bool: 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 (Required): The name of the pipeline.
- ParameterObjects: ParameterObject[]: The parameter objects used with the pipeline.
- ParameterValues: ParameterValue[]: The parameter values used with the pipeline.
- PipelineId: string (ReadOnly, Identifier)
- 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.
- Attributes: ParameterAttribute[] (Required): The attributes of the parameter object.
- Id: string (Required): The ID of the parameter object.
- Key: string (Required): The field identifier.
- StringValue: string (Required): The field value, expressed as a String.
- Id: string (Required): The ID of the parameter value.
- StringValue: string (Required): The field value, expressed as a String.
- Fields: Field[] (Required): Key-value pairs that define the properties of the object.
- Id: string (Required): The ID of the object.
- Name: string (Required): The name of the object.
- Key: string (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: A field value that you specify as an identifier of another object in the same pipeline definition.
- StringValue: string: 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.
- Key: string (Required): The key name of a tag.
- Value: string (Required): The value to associate with the key name.