Class CfnPipeline
The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data.
Inherited Members
Namespace: Amazon.CDK.AWS.DataPipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPipeline : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnPipeline
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. For information about pipeline objects and components that you can use, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .
The AWS::DataPipeline::Pipeline
resource 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 validation errors exist in the pipeline.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
CloudformationResource: AWS::DataPipeline::Pipeline
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataPipeline;
var cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
Name = "name",
// the properties below are optional
Activate = false,
Description = "description",
ParameterObjects = new [] { new ParameterObjectProperty {
Attributes = new [] { new ParameterAttributeProperty {
Key = "key",
StringValue = "stringValue"
} },
Id = "id"
} },
ParameterValues = new [] { new ParameterValueProperty {
Id = "id",
StringValue = "stringValue"
} },
PipelineObjects = new [] { new PipelineObjectProperty {
Fields = new [] { new FieldProperty {
Key = "key",
// the properties below are optional
RefValue = "refValue",
StringValue = "stringValue"
} },
Id = "id",
Name = "name"
} },
PipelineTags = new [] { new PipelineTagProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnPipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPipeline(Construct, String, ICfnPipelineProps) |
Properties
Activate | Indicates whether to validate and start the pipeline or stop an active pipeline. |
AttrId | |
AttrPipelineId | The ID of the pipeline. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the pipeline. |
Name | The name of the pipeline. |
ParameterObjects | The parameter objects used with the pipeline. |
ParameterValues | The parameter values used with the pipeline. |
PipelineObjects | The objects that define the pipeline. |
PipelineTags | A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPipeline(Construct, String, ICfnPipelineProps)
public CfnPipeline(Construct scope, string id, ICfnPipelineProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnPipelineProps
Resource properties.
Properties
Activate
Indicates whether to validate and start the pipeline or stop an active pipeline.
public virtual object Activate { get; set; }
Property Value
System.Object
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrPipelineId
The ID of the pipeline.
public virtual string AttrPipelineId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PipelineId
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the pipeline.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name of the pipeline.
public virtual string Name { get; set; }
Property Value
System.String
ParameterObjects
The parameter objects used with the pipeline.
public virtual object ParameterObjects { get; set; }
Property Value
System.Object
ParameterValues
The parameter values used with the pipeline.
public virtual object ParameterValues { get; set; }
Property Value
System.Object
PipelineObjects
The objects that define the pipeline.
public virtual object PipelineObjects { get; set; }
Property Value
System.Object
PipelineTags
A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.
public virtual CfnPipeline.IPipelineTagProperty[] PipelineTags { get; set; }
Property Value
CfnPipeline.IPipelineTagProperty[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>