Class: AWSCDK::Pipelines::StageDeploymentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pipelines/stage_deployment_props.rb

Overview

Properties for a StageDeployment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(post: nil, pre: nil, stack_steps: nil, stage_name: nil) ⇒ StageDeploymentProps

Returns a new instance of StageDeploymentProps.

Parameters:

  • post (Array<AWSCDK::Pipelines::Step>, nil) (defaults to: nil) —

    Additional steps to run after all of the stacks in the stage.

  • pre (Array<AWSCDK::Pipelines::Step>, nil) (defaults to: nil) —

    Additional steps to run before any of the stacks in the stage.

  • stack_steps (Array<AWSCDK::Pipelines::StackSteps>, nil) (defaults to: nil) —

    Instructions for additional steps that are run at the stack level.

  • stage_name (String, nil) (defaults to: nil) —

    Stage name to use in the pipeline.



11
12
13
14
15
16
17
18
19
20
 
# File 'pipelines/stage_deployment_props.rb', line 11

def initialize(post: nil, pre: nil, stack_steps: nil, stage_name: nil)
  @post = post
  Jsii::Type.check_type(@post, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLnBpcGVsaW5lcy5TdGVwIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "post") unless @post.nil?
  @pre = pre
  Jsii::Type.check_type(@pre, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLnBpcGVsaW5lcy5TdGVwIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "pre") unless @pre.nil?
  @stack_steps = stack_steps.is_a?(Array) ? stack_steps.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::Pipelines::StackSteps.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : stack_steps
  Jsii::Type.check_type(@stack_steps, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLnBpcGVsaW5lcy5TdGFja1N0ZXBzIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "stackSteps") unless @stack_steps.nil?
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName") unless @stage_name.nil?
end

Instance Attribute Details

#post ⇒ Array<AWSCDK::Pipelines::Step>? (readonly)

Note:

Default: - No additional steps

Additional steps to run after all of the stacks in the stage.

Returns:



26
27
28
 
# File 'pipelines/stage_deployment_props.rb', line 26

def post
  @post
end

#pre ⇒ Array<AWSCDK::Pipelines::Step>? (readonly)

Note:

Default: - No additional steps

Additional steps to run before any of the stacks in the stage.

Returns:



31
32
33
 
# File 'pipelines/stage_deployment_props.rb', line 31

def pre
  @pre
end

#stack_steps ⇒ Array<AWSCDK::Pipelines::StackSteps>? (readonly)

Note:

Default: - No additional instructions

Instructions for additional steps that are run at the stack level.

Returns:



36
37
38
 
# File 'pipelines/stage_deployment_props.rb', line 36

def stack_steps
  @stack_steps
end

#stage_name ⇒ String? (readonly)

Note:

Default: - Use Stage's construct ID

Stage name to use in the pipeline.

Returns:

  • (String, nil) 


41
42
43
 
# File 'pipelines/stage_deployment_props.rb', line 41

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'pipelines/stage_deployment_props.rb', line 43

def self.jsii_properties
  {
    :post => "post",
    :pre => "pre",
    :stack_steps => "stackSteps",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'pipelines/stage_deployment_props.rb', line 52

def to_jsii
  result = {}
  result.merge!({
    "post" => @post,
    "pre" => @pre,
    "stackSteps" => @stack_steps,
    "stageName" => @stage_name,
  })
  result.compact
end