software.amazon.awscdk.pipelines

Class FileSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.FileSet

All Implemented Interfaces:

IFileSetProducer, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

CodePipelineFileSet

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.938Z")
 @Stability(value=Stable)
public class FileSet
extends software.amazon.jsii.JsiiObject
implements IFileSetProducer

A set of files traveling through the deployment pipeline.

Individual steps in the pipeline produce or consume FileSets.

Example:

 public class MyJenkinsStep extends Step implements ICodePipelineActionFactory {
     public MyJenkinsStep(JenkinsProvider provider, FileSet input) {
         super("MyJenkinsStep");
         // This is necessary if your step accepts parametres, 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.
         this.discoverReferencedOutputs(Map.of(
                 "env", Map.of()));
     }
     public CodePipelineActionFactoryResult produceAction(IStage stage, ProduceActionOptions options) {
         // This is where you control what type of Action gets added to the
         // CodePipeline
         stage.addAction(JenkinsAction.Builder.create()
                 // Copy 'actionName' and 'runOrder' from the options
                 .actionName(options.getActionName())
                 .runOrder(options.getRunOrder())
                 // Jenkins-specific configuration
                 .type(JenkinsActionType.TEST)
                 .jenkinsProvider(this.provider)
                 .projectName("MyJenkinsProject")
                 // Translate the FileSet into a codepipeline.Artifact
                 .inputs(List.of(options.artifacts.toCodePipeline(this.input)))
                 .build());
         return CodePipelineActionFactoryResult.builder().runOrdersConsumed(1).build();
     }
 }
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.pipelines.IFileSetProducer

IFileSetProducer.Jsii$Default, IFileSetProducer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FileSet(software.amazon.jsii.JsiiObjectRef objRef)
	FileSet(String id)
	FileSet(String id, Step producer)

Method Summary

Modifier and Type	Method and Description
String	getId() Human-readable descriptor for this file set (does not need to be unique).
FileSet	getPrimaryOutput() The primary output of a file set producer.
Step	getProducer() The Step that produces this FileSet.
void	producedBy() Mark the given Step as the producer for this FileSet.
void	producedBy(Step producer) Mark the given Step as the producer for this FileSet.
String	toString() Return a string representation of this FileSet.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

FileSet

protected FileSet(software.amazon.jsii.JsiiObjectRef objRef)

FileSet

protected FileSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

FileSet

@Stability(value=Stable)
public FileSet(@NotNull
                                        String id,
                                        @Nullable
                                        Step producer)

Parameters:

id - Human-readable descriptor for this file set (does not need to be unique). This parameter is required.

producer -

FileSet

@Stability(value=Stable)
public FileSet(@NotNull
                                        String id)

Parameters:

id - Human-readable descriptor for this file set (does not need to be unique). This parameter is required.

Method Detail

producedBy

@Stability(value=Stable)
public void producedBy(@Nullable
                                                Step producer)

Mark the given Step as the producer for this FileSet.

This method can only be called once.

Parameters:

producer -

producedBy

@Stability(value=Stable)
public void producedBy()

Mark the given Step as the producer for this FileSet.

This method can only be called once.

toString

@Stability(value=Stable)
 @NotNull
public String toString()

Return a string representation of this FileSet.

Overrides:

toString in class Object

getId

@Stability(value=Stable)
 @NotNull
public String getId()

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

getProducer

@Stability(value=Stable)
 @NotNull
public Step getProducer()

The Step that produces this FileSet.

getPrimaryOutput

@Stability(value=Stable)
 @Nullable
public FileSet getPrimaryOutput()

The primary output of a file set producer.

The primary output of a FileSet is itself.

Specified by:

getPrimaryOutput in interface IFileSetProducer