Readonly
dependencyThe list of FileSets consumed by this Step
Readonly
envOptional
Readonly
githubReadonly
idReadonly
isWhether or not this is a Source step
What it means to be a Source step depends on the engine.
Readonly
jobOptional
Readonly
permissionsReadonly
propsStackOutputReferences this step consumes.
Return the steps this step depends on, based on the FileSets it requires
The primary FileSet produced by this Step
Not all steps produce an output FileSet--if they do
you can substitute the Step
object for the FileSet
object.
Protected
addAdd an additional FileSet to the set of file sets required by this step
This will lead to a dependency on the producer of that file set.
Add a dependency on another step.
Protected
configureConfigure the given FileSet as the primary output of this step
Protected
discoverCrawl the given structure for references to StepOutputs and add dependencies on all steps found
Should be called in the constructor of subclasses based on what the user passes in as construction properties. The format of the structure passed in here does not have to correspond exactly to what gets rendered into the engine, it just needs to contain the same data.
Flip the source and destination.
Optional
props: Partial<S3BucketStepProps>Additional props used as overrides.
Return a string representation of this Step
Static
buildBuild an s3 uri from the given object reference.
The object reference or file path.
Optional
scoped: booleanWhether to scope the object reference to the workflow.
Static
buildBuild an s3 uri with a key prefix scoped by workflow run id and attempt.
The object reference to scope.
Static
sequenceDefine a sequence of steps to be executed in order.
If you need more fine-grained step ordering, use the addStepDependency()
API. For example, if you want secondStep
to occur after firstStep
, call
secondStep.addStepDependency(firstStep)
.
A step that performs an action on an s3 bucket.