Class: AWSCDK::Codepipeline::VariableProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
codepipeline/variable_props.rb

Overview

Properties of pipeline-level variable.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(variable_name:, default_value: nil, description: nil) ⇒ VariableProps

Returns a new instance of VariableProps.

Parameters:

  • variable_name (String) —

    The name of a pipeline-level variable.

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

    The default value of a pipeline-level variable.

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

    The description of a pipeline-level variable.



10
11
12
13
14
15
16
17
 
# File 'codepipeline/variable_props.rb', line 10

def initialize(variable_name:, default_value: nil, description: nil)
  @variable_name = variable_name
  Jsii::Type.check_type(@variable_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "variableName")
  @default_value = default_value
  Jsii::Type.check_type(@default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless @default_value.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#default_value ⇒ String? (readonly)

Note:

Default: - No default value.

The default value of a pipeline-level variable.

Returns:

  • (String, nil) 


27
28
29
 
# File 'codepipeline/variable_props.rb', line 27

def default_value
  @default_value
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

The description of a pipeline-level variable.

It's used to add additional context about the variable, and not being used at time when pipeline executes.

Returns:

  • (String, nil) 


35
36
37
 
# File 'codepipeline/variable_props.rb', line 35

def description
  @description
end

#variable_name ⇒ String (readonly)

The name of a pipeline-level variable.

Returns:

  • (String) 


22
23
24
 
# File 'codepipeline/variable_props.rb', line 22

def variable_name
  @variable_name
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'codepipeline/variable_props.rb', line 37

def self.jsii_properties
  {
    :variable_name => "variableName",
    :default_value => "defaultValue",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'codepipeline/variable_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "variableName" => @variable_name,
    "defaultValue" => @default_value,
    "description" => @description,
  })
  result.compact
end