Class: AWSCDK::Pipelines::ManualApprovalStep

Inherits:
Step
  • Object
show all
Defined in:
pipelines/manual_approval_step.rb

Overview

A manual approval step.

If this step is added to a Pipeline, the Pipeline will be paused waiting for a human to resume it

Only engines that support pausing the deployment will support this step type.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, props = nil) ⇒ ManualApprovalStep

Returns a new instance of ManualApprovalStep.

Parameters:



16
17
18
19
20
21
 
# File 'pipelines/manual_approval_step.rb', line 16

def initialize(id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Pipelines::ManualApprovalStepProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuTWFudWFsQXBwcm92YWxTdGVwUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'pipelines/manual_approval_step.rb', line 23

def self.jsii_overridable_methods
  {
    :consumed_stack_outputs => { kind: :property, name: "consumedStackOutputs", is_optional: false },
    :dependencies => { kind: :property, name: "dependencies", is_optional: false },
    :dependency_file_sets => { kind: :property, name: "dependencyFileSets", is_optional: false },
    :id => { kind: :property, name: "id", is_optional: false },
    :is_source => { kind: :property, name: "isSource", is_optional: false },
    :primary_output => { kind: :property, name: "primaryOutput", is_optional: true },
    :comment => { kind: :property, name: "comment", is_optional: true },
    :notification_topic => { kind: :property, name: "notificationTopic", is_optional: true },
    :review_url => { kind: :property, name: "reviewUrl", is_optional: true },
    :add_dependency_file_set => { kind: :method, name: "addDependencyFileSet", is_optional: false },
    :add_step_dependency => { kind: :method, name: "addStepDependency", is_optional: false },
    :configure_primary_output => { kind: :method, name: "configurePrimaryOutput", is_optional: false },
    :discover_referenced_outputs => { kind: :method, name: "discoverReferencedOutputs", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
  }
end

Instance Method Details

#add_dependency_file_set(fs) ⇒ void

This method returns an undefined value.

Add 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.

Parameters:



119
120
121
122
 
# File 'pipelines/manual_approval_step.rb', line 119

def add_dependency_file_set(fs)
  Jsii::Type.check_type(fs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuRmlsZVNldCJ9")), "fs")
  jsii_call_method("addDependencyFileSet", [fs])
end

#add_step_dependency(step) ⇒ void

This method returns an undefined value.

Add a dependency on another step.

Parameters:



128
129
130
131
 
# File 'pipelines/manual_approval_step.rb', line 128

def add_step_dependency(step)
  Jsii::Type.check_type(step, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuU3RlcCJ9")), "step")
  jsii_call_method("addStepDependency", [step])
end

#comment ⇒ String?

Note:

Default: - No comment

The comment associated with this manual approval.

Returns:

  • (String, nil) 


93
94
95
 
# File 'pipelines/manual_approval_step.rb', line 93

def comment()
  jsii_get_property("comment")
end

#configure_primary_output(fs) ⇒ void

This method returns an undefined value.

Configure the given FileSet as the primary output of this step.

Parameters:



137
138
139
140
 
# File 'pipelines/manual_approval_step.rb', line 137

def configure_primary_output(fs)
  Jsii::Type.check_type(fs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuRmlsZVNldCJ9")), "fs")
  jsii_call_method("configurePrimaryOutput", [fs])
end

#consumed_stack_outputs ⇒ Array<AWSCDK::Pipelines::StackOutputReference>

StackOutputReferences this step consumes.

Returns:



45
46
47
 
# File 'pipelines/manual_approval_step.rb', line 45

def consumed_stack_outputs()
  jsii_get_property("consumedStackOutputs")
end

#dependencies ⇒ Array<AWSCDK::Pipelines::Step>

Return the steps this step depends on, based on the FileSets it requires.

Returns:



52
53
54
 
# File 'pipelines/manual_approval_step.rb', line 52

def dependencies()
  jsii_get_property("dependencies")
end

#dependency_file_sets ⇒ Array<AWSCDK::Pipelines::FileSet>

The list of FileSets consumed by this Step.

Returns:



59
60
61
 
# File 'pipelines/manual_approval_step.rb', line 59

def dependency_file_sets()
  jsii_get_property("dependencyFileSets")
end

#discover_referenced_outputs(structure) ⇒ void

This method returns an undefined value.

Crawl 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.

Parameters:

  • structure (Object) 


151
152
153
154
 
# File 'pipelines/manual_approval_step.rb', line 151

def discover_referenced_outputs(structure)
  Jsii::Type.check_type(structure, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "structure")
  jsii_call_method("discoverReferencedOutputs", [structure])
end

#id ⇒ String

Identifier for this step.

Returns:

  • (String) 


66
67
68
 
# File 'pipelines/manual_approval_step.rb', line 66

def id()
  jsii_get_property("id")
end

#is_source ⇒ Boolean

Whether or not this is a Source step.

What it means to be a Source step depends on the engine.

Returns:

  • (Boolean) 


75
76
77
 
# File 'pipelines/manual_approval_step.rb', line 75

def is_source()
  jsii_get_property("isSource")
end

#notification_topic ⇒ AWSCDK::SNS::ITopic?

Note:

Default: - No notifications

Optional SNS topic to send notifications.

Returns:



101
102
103
 
# File 'pipelines/manual_approval_step.rb', line 101

def notification_topic()
  jsii_get_property("notificationTopic")
end

#primary_output ⇒ AWSCDK::Pipelines::FileSet?

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.

Returns:



85
86
87
 
# File 'pipelines/manual_approval_step.rb', line 85

def primary_output()
  jsii_get_property("primaryOutput")
end

#review_url ⇒ String?

Note:

Default: - No URL

The URL for review associated with this manual approval.

Returns:

  • (String, nil) 


109
110
111
 
# File 'pipelines/manual_approval_step.rb', line 109

def review_url()
  jsii_get_property("reviewUrl")
end

#to_string ⇒ String

Return a string representation of this Step.

Returns:

  • (String) 


159
160
161
 
# File 'pipelines/manual_approval_step.rb', line 159

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