Class FileSet

A set of files traveling through the deployment pipeline.

Inheritance
object
FileSet
CodePipelineFileSet
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 FileSets.

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(string, Step?)

A set of files traveling through the deployment pipeline.

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(string, Step?)

A set of files traveling through the deployment pipeline.

public FileSet(string id, Step? producer = null)
Parameters
id 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).

Remarks

Individual steps in the pipeline produce or consume FileSets.

ExampleMetadata: infused

Properties

Id

Human-readable descriptor for this file set (does not need to be unique).

public virtual string Id { get; }
Property Value

string

Remarks

Individual steps in the pipeline produce or consume FileSets.

ExampleMetadata: infused

PrimaryOutput

The primary output of a file set producer.

public virtual FileSet? PrimaryOutput { get; }
Property Value

FileSet

Remarks

The primary output of a FileSet is itself.

Producer

The Step that produces this FileSet.

public virtual Step Producer { get; }
Property Value

Step

Remarks

Individual steps in the pipeline produce or consume FileSets.

ExampleMetadata: infused

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

string

Remarks

Individual steps in the pipeline produce or consume FileSets.

ExampleMetadata: infused

Implements