Class FileSet
A set of files traveling through the deployment pipeline.
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FileSet : DeputyBase, IFileSetProducer
Syntax (vb)
Public Class FileSet
Inherits DeputyBase
Implements IFileSetProducer
Remarks
Individual steps in the pipeline produce or consume
FileSet
s.
ExampleMetadata: infused
Examples
class MyJenkinsStep : Step, ICodePipelineActionFactory
{
public MyJenkinsStep(JenkinsProvider provider, FileSet input) : base("MyJenkinsStep")
{
// This is necessary if your step accepts parameters, like environment variables,
// that may contain outputs from other steps. It doesn't matter what the
// structure is, as long as it contains the values that may contain outputs.
DiscoverReferencedOutputs(new Dictionary<string, IDictionary<string, object>> {
{ "env", new Struct { } }
});
}
public CodePipelineActionFactoryResult ProduceAction(IStage stage, ProduceActionOptions options)
{
// This is where you control what type of Action gets added to the
// CodePipeline
stage.AddAction(new JenkinsAction(new JenkinsActionProps {
// Copy 'actionName' and 'runOrder' from the options
ActionName = options.ActionName,
RunOrder = options.RunOrder,
// Jenkins-specific configuration
Type = JenkinsActionType.TEST,
JenkinsProvider = Provider,
ProjectName = "MyJenkinsProject",
// Translate the FileSet into a codepipeline.Artifact
Inputs = new [] { options.Artifacts.ToCodePipeline(Input) }
}));
return new CodePipelineActionFactoryResult { RunOrdersConsumed = 1 };
}
}
Synopsis
Constructors
FileSet(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
FileSet(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
FileSet(String, Step) |
Properties
Id | Human-readable descriptor for this file set (does not need to be unique). |
PrimaryOutput | The primary output of a file set producer. |
Producer | The Step that produces this FileSet. |
Methods
ProducedBy(Step) | Mark the given Step as the producer for this FileSet. |
ToString() | Return a string representation of this FileSet. |
Constructors
FileSet(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected FileSet(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
FileSet(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected FileSet(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
FileSet(String, Step)
public FileSet(string id, Step producer = null)
Parameters
- id System.String
Human-readable descriptor for this file set (does not need to be unique).
- producer Step
Human-readable descriptor for this file set (does not need to be unique).
Properties
Id
Human-readable descriptor for this file set (does not need to be unique).
public virtual string Id { get; }
Property Value
System.String
PrimaryOutput
The primary output of a file set producer.
public virtual FileSet PrimaryOutput { get; }
Property Value
Remarks
The primary output of a FileSet is itself.
Producer
Methods
ProducedBy(Step)
Mark the given Step as the producer for this FileSet.
public virtual void ProducedBy(Step producer = null)
Parameters
- producer Step
Remarks
This method can only be called once.
ToString()
Return a string representation of this FileSet.
public override string ToString()
Returns
System.String