Class: AWSCDK::Pipelines::ConfirmPermissionsBroadening

Inherits:
Step
  • Object
show all
Includes:
ICodePipelineActionFactory
Defined in:
pipelines/confirm_permissions_broadening.rb

Overview

Pause the pipeline if a deployment would add IAM permissions or Security Group rules.

This step is only supported in CodePipeline pipelines.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, props) ⇒ ConfirmPermissionsBroadening

Returns a new instance of ConfirmPermissionsBroadening.

Parameters:



13
14
15
16
17
18
 
# File 'pipelines/confirm_permissions_broadening.rb', line 13

def initialize(id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Pipelines::PermissionsBroadeningCheckProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuUGVybWlzc2lvbnNCcm9hZGVuaW5nQ2hlY2tQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'pipelines/confirm_permissions_broadening.rb', line 20

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 },
    :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 },
    :produce_action => { kind: :method, name: "produceAction", 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:



90
91
92
93
 
# File 'pipelines/confirm_permissions_broadening.rb', line 90

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:



99
100
101
102
 
# File 'pipelines/confirm_permissions_broadening.rb', line 99

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

#configure_primary_output(fs) ⇒ void

This method returns an undefined value.

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

Parameters:



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

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:



40
41
42
 
# File 'pipelines/confirm_permissions_broadening.rb', line 40

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:



47
48
49
 
# File 'pipelines/confirm_permissions_broadening.rb', line 47

def dependencies()
  jsii_get_property("dependencies")
end

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

The list of FileSets consumed by this Step.

Returns:



54
55
56
 
# File 'pipelines/confirm_permissions_broadening.rb', line 54

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) 


122
123
124
125
 
# File 'pipelines/confirm_permissions_broadening.rb', line 122

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) 


61
62
63
 
# File 'pipelines/confirm_permissions_broadening.rb', line 61

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) 


70
71
72
 
# File 'pipelines/confirm_permissions_broadening.rb', line 70

def is_source()
  jsii_get_property("isSource")
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:



80
81
82
 
# File 'pipelines/confirm_permissions_broadening.rb', line 80

def primary_output()
  jsii_get_property("primaryOutput")
end

#produce_action(stage, options) ⇒ AWSCDK::Pipelines::CodePipelineActionFactoryResult

Create the desired Action and add it to the pipeline.

Parameters:

Returns:



139
140
141
142
143
144
 
# File 'pipelines/confirm_permissions_broadening.rb', line 139

def produce_action(stage, options)
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLklTdGFnZSJ9")), "stage")
  options = options.is_a?(Hash) ? ::AWSCDK::Pipelines::ProduceActionOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuUHJvZHVjZUFjdGlvbk9wdGlvbnMifQ==")), "options")
  jsii_call_method("produceAction", [stage, options])
end

#to_string ⇒ String

Return a string representation of this Step.

Returns:

  • (String) 


130
131
132
 
# File 'pipelines/confirm_permissions_broadening.rb', line 130

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