Class: AWSCDK::CodePipelineActions::StateMachineInput

Inherits:
Jsii::Object
  • Object
show all
Defined in:
code_pipeline_actions/state_machine_input.rb

Overview

Represents the input for the StateMachine.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ StateMachineInput

Returns a new instance of StateMachineInput.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'code_pipeline_actions/state_machine_input.rb', line 8

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

Class Method Details

.file_path(input_file) ⇒ AWSCDK::CodePipelineActions::StateMachineInput

When the input type is FilePath, input artifact and filepath must be specified.

Parameters:

Returns:

  • (AWSCDK::CodePipelineActions::StateMachineInput) 


24
25
26
27
 
# File 'code_pipeline_actions/state_machine_input.rb', line 24

def self.file_path(input_file)
  Jsii::Type.check_type(input_file, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFydGlmYWN0UGF0aCJ9")), "inputFile")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codepipeline_actions.StateMachineInput", "filePath", [input_file])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
 
# File 'code_pipeline_actions/state_machine_input.rb', line 12

def self.jsii_overridable_methods
  {
    :input => { kind: :property, name: "input", is_optional: false },
    :input_artifact => { kind: :property, name: "inputArtifact", is_optional: true },
    :input_type => { kind: :property, name: "inputType", is_optional: true },
  }
end

.literal(object) ⇒ AWSCDK::CodePipelineActions::StateMachineInput

When the input type is Literal, input value is passed directly to the state machine input.

Parameters:

  • object (Hash)

Returns:

  • (AWSCDK::CodePipelineActions::StateMachineInput) 


33
34
35
36
 
# File 'code_pipeline_actions/state_machine_input.rb', line 33

def self.literal(object)
  Jsii::Type.check_type(object, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJqc29uIn0=")), "object")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codepipeline_actions.StateMachineInput", "literal", [object])
end

Instance Method Details

#input ⇒ Object

Note:

Default: - none

When InputType is set to Literal (default), the Input field is used directly as the input for the state machine execution.

Otherwise, the state machine is invoked with an empty JSON object {}.

When InputType is set to FilePath, this field is required. An input artifact is also required when InputType is set to FilePath.

Returns:

  • (Object) 


47
48
49
 
# File 'code_pipeline_actions/state_machine_input.rb', line 47

def input()
  jsii_get_property("input")
end

#input_artifact ⇒ AWSCDK::Codepipeline::Artifact?

Note:

Default: - the Action will not have any inputs

The optional input Artifact of the Action.

If InputType is set to FilePath, this artifact is required and is used to source the input for the state machine execution.

Returns:

See Also:



59
60
61
 
# File 'code_pipeline_actions/state_machine_input.rb', line 59

def input_artifact()
  jsii_get_property("inputArtifact")
end

#input_type ⇒ String?

Note:

Default: - Literal

Optional StateMachine InputType InputType can be Literal or FilePath.

Returns:

  • (String, nil) 


67
68
69
 
# File 'code_pipeline_actions/state_machine_input.rb', line 67

def input_type()
  jsii_get_property("inputType")
end