Class: AWSCDK::Pipelines::CodePipelineFileSet

Inherits:
FileSet
  • Object
show all
Defined in:
pipelines/code_pipeline_file_set.rb

Overview

A FileSet created from a CodePipeline artifact.

You only need to use this if you want to add CDK Pipeline stages add the end of an existing CodePipeline, which should be very rare.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ CodePipelineFileSet

Returns a new instance of CodePipelineFileSet.

Raises:

  • (NoMethodError) 


11
12
13
 
# File 'pipelines/code_pipeline_file_set.rb', line 11

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.pipelines.CodePipelineFileSet does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.from_artifact(artifact) ⇒ AWSCDK::Pipelines::CodePipelineFileSet

Turn a CodePipeline Artifact into a FileSet.

Parameters:

Returns:

  • (AWSCDK::Pipelines::CodePipelineFileSet) 


29
30
31
32
 
# File 'pipelines/code_pipeline_file_set.rb', line 29

def self.from_artifact(artifact)
  Jsii::Type.check_type(artifact, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0In0=")), "artifact")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.pipelines.CodePipelineFileSet", "fromArtifact", [artifact])
end

.jsii_overridable_methods ⇒ Object 



15
16
17
18
19
20
21
22
23
 
# File 'pipelines/code_pipeline_file_set.rb', line 15

def self.jsii_overridable_methods
  {
    :id => { kind: :property, name: "id", is_optional: false },
    :producer => { kind: :property, name: "producer", is_optional: false },
    :primary_output => { kind: :property, name: "primaryOutput", is_optional: true },
    :produced_by => { kind: :method, name: "producedBy", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
  }
end

Instance Method Details

#id ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'pipelines/code_pipeline_file_set.rb', line 37

def id()
  jsii_get_property("id")
end

#primary_output ⇒ AWSCDK::Pipelines::FileSet?

The primary output of a file set producer.

The primary output of a FileSet is itself.

Returns:



53
54
55
 
# File 'pipelines/code_pipeline_file_set.rb', line 53

def primary_output()
  jsii_get_property("primaryOutput")
end

#produced_by(producer = nil) ⇒ void

This method returns an undefined value.

Mark the given Step as the producer for this FileSet.

This method can only be called once.

Parameters:



63
64
65
66
 
# File 'pipelines/code_pipeline_file_set.rb', line 63

def produced_by(producer = nil)
  Jsii::Type.check_type(producer, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuU3RlcCJ9")), "producer") unless producer.nil?
  jsii_call_method("producedBy", [producer])
end

#producer ⇒ AWSCDK::Pipelines::Step

The Step that produces this FileSet.

Returns:



44
45
46
 
# File 'pipelines/code_pipeline_file_set.rb', line 44

def producer()
  jsii_get_property("producer")
end

#to_string ⇒ String

Return a string representation of this FileSet.

Returns:

  • (String) 


71
72
73
 
# File 'pipelines/code_pipeline_file_set.rb', line 71

def to_string()
  jsii_call_method("toString", [])
end