Class: AWSCDK::CodePipelineActions::CloudFormationDeployStackInstancesAction

Inherits:
Action
  • Object
show all
Defined in:
code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb

Overview

CodePipeline action to create/update Stack Instances of a StackSet.

After the initial creation of a stack set, you can add new stack instances by using CloudFormationStackInstances. Template parameter values can be overridden at the stack instance level during create or update stack set instance operations.

Each stack set has one template and set of template parameters. When you update the template or template parameters, you update them for the entire set. Then all instance statuses are set to OUTDATED until the changes are deployed to that instance.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(props) ⇒ CloudFormationDeployStackInstancesAction

Returns a new instance of CloudFormationDeployStackInstancesAction.

Parameters:



19
20
21
22
23
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 19

def initialize(props)
  props = props.is_a?(Hash) ? ::AWSCDK::CodePipelineActions::CloudFormationDeployStackInstancesActionProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lX2FjdGlvbnMuQ2xvdWRGb3JtYXRpb25EZXBsb3lTdGFja0luc3RhbmNlc0FjdGlvblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



25
26
27
28
29
30
31
32
33
34
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 25

def self.jsii_overridable_methods
  {
    :action_properties => { kind: :property, name: "actionProperties", is_optional: false },
    :provided_action_properties => { kind: :property, name: "providedActionProperties", is_optional: false },
    :bind => { kind: :method, name: "bind", is_optional: false },
    :bound => { kind: :method, name: "bound", is_optional: false },
    :on_state_change => { kind: :method, name: "onStateChange", is_optional: false },
    :variable_expression => { kind: :method, name: "variableExpression", is_optional: false },
  }
end

Instance Method Details

#action_properties ⇒ AWSCDK::Codepipeline::ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

Returns:



41
42
43
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 41

def action_properties()
  jsii_get_property("actionProperties")
end

#bind(scope, stage, options) ⇒ AWSCDK::Codepipeline::ActionConfig

The callback invoked when this Action is added to a Pipeline.

Parameters:

Returns:



58
59
60
61
62
63
64
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 58

def bind(scope, stage, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLklTdGFnZSJ9")), "stage")
  options = options.is_a?(Hash) ? ::AWSCDK::Codepipeline::ActionBindOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFjdGlvbkJpbmRPcHRpb25zIn0=")), "options")
  jsii_call_method("bind", [scope, stage, options])
end

#bound(scope, _stage, options) ⇒ AWSCDK::Codepipeline::ActionConfig

This is a renamed version of the IAction.bind method.

Parameters:

Returns:



72
73
74
75
76
77
78
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 72

def bound(scope, _stage, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(_stage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLklTdGFnZSJ9")), "_stage")
  options = options.is_a?(Hash) ? ::AWSCDK::Codepipeline::ActionBindOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkFjdGlvbkJpbmRPcHRpb25zIn0=")), "options")
  jsii_call_method("bound", [scope, _stage, options])
end

#on_state_change(name, target = nil, options = nil) ⇒ AWSCDK::Events::Rule

Creates an Event that will be triggered whenever the state of this Action changes.

Parameters:

Returns:



86
87
88
89
90
91
92
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 86

def on_state_change(name, target = nil, options = nil)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLklSdWxlVGFyZ2V0In0=")), "target") unless target.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::Events::RuleProps.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLlJ1bGVQcm9wcyJ9")), "options") unless options.nil?
  jsii_call_method("onStateChange", [name, target, options])
end

#provided_action_properties ⇒ AWSCDK::Codepipeline::ActionProperties

This is a renamed version of the IAction.actionProperties property.

Returns:



48
49
50
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 48

def provided_action_properties()
  jsii_get_property("providedActionProperties")
end

#variable_expression(variable_name) ⇒ String

Parameters:

  • variable_name (String)

Returns:

  • (String) 


96
97
98
99
 
# File 'code_pipeline_actions/cloud_formation_deploy_stack_instances_action.rb', line 96

def variable_expression(variable_name)
  Jsii::Type.check_type(variable_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "variableName")
  jsii_call_method("variableExpression", [variable_name])
end