Class: AWSCDK::Codepipeline::CfnPipeline::VariableDeclarationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Codepipeline::CfnPipeline::VariableDeclarationProperty

Defined in:

codepipeline/cfn_pipeline.rb

Overview

A variable declared at the pipeline level.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html

Instance Attribute Summary

• #default_value ⇒ String^? readonly

  The value of a pipeline-level variable.

• #description ⇒ String^? readonly

  The description of a pipeline-level variable.

• #name ⇒ String readonly

  The name of a pipeline-level variable.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, default_value: nil, description: nil) ⇒ VariableDeclarationProperty constructor

  A new instance of VariableDeclarationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, default_value: nil, description: nil) ⇒ VariableDeclarationProperty

Returns a new instance of VariableDeclarationProperty.

Parameters:

• name (String) —

  The name of a pipeline-level variable.

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

  The value of a pipeline-level variable.

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

  The description of a pipeline-level variable.

# File 'codepipeline/cfn_pipeline.rb', line 2135

def initialize(name:, default_value: nil, description: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @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)

The value of a pipeline-level variable.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-defaultvalue

# File 'codepipeline/cfn_pipeline.rb', line 2153

def default_value
  @default_value
end

#description ⇒ String^? (readonly)

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)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-description

# File 'codepipeline/cfn_pipeline.rb', line 2160

def description
  @description
end

#name ⇒ String (readonly)

The name of a pipeline-level variable.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-name

# File 'codepipeline/cfn_pipeline.rb', line 2148

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'codepipeline/cfn_pipeline.rb', line 2162

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

Instance Method Details

#to_jsii ⇒ Object

# File 'codepipeline/cfn_pipeline.rb', line 2170

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