Interface ICfnPipelineProps
Properties for defining a CfnPipeline
.
Namespace: Amazon.CDK.AWS.DataPipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnPipelineProps
Syntax (vb)
Public Interface ICfnPipelineProps
Remarks
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 cfnPipelineProps = 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
Properties
Activate | Indicates whether to validate and start the pipeline or stop an active pipeline. |
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. |
Properties
Activate
Indicates whether to validate and start the pipeline or stop an active pipeline.
virtual object Activate { get; }
Property Value
System.Object
Remarks
By default, the value is set to true
.
Description
A description of the pipeline.
virtual string Description { get; }
Property Value
System.String
Remarks
Name
The name of the pipeline.
string Name { get; }
Property Value
System.String
Remarks
ParameterObjects
The parameter objects used with the pipeline.
virtual object ParameterObjects { get; }
Property Value
System.Object
Remarks
ParameterValues
The parameter values used with the pipeline.
virtual object ParameterValues { get; }
Property Value
System.Object
Remarks
PipelineObjects
The objects that define the pipeline.
virtual object PipelineObjects { get; }
Property Value
System.Object
Remarks
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
A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.
virtual CfnPipeline.IPipelineTagProperty[] PipelineTags { get; }
Property Value
CfnPipeline.IPipelineTagProperty[]
Remarks
For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide .