Class: AWSCDK::CloudFormation::CfnStack::OutputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_formation/cfn_stack.rb

Overview

The Output data type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, export_name: nil, output_key: nil, output_value: nil) ⇒ OutputProperty

Returns a new instance of OutputProperty.

Parameters:

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

    User defined description associated with the output.

  • export_name (String, nil) (defaults to: nil)

    The name of the export associated with the output.

  • output_key (String, nil) (defaults to: nil)

    The key associated with the output.

  • output_value (String, nil) (defaults to: nil)

    The value associated with the output.



669
670
671
672
673
674
675
676
677
678
# File 'cloud_formation/cfn_stack.rb', line 669

def initialize(description: nil, export_name: nil, output_key: nil, output_value: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @export_name = export_name
  Jsii::Type.check_type(@export_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "exportName") unless @export_name.nil?
  @output_key = output_key
  Jsii::Type.check_type(@output_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputKey") unless @output_key.nil?
  @output_value = output_value
  Jsii::Type.check_type(@output_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputValue") unless @output_value.nil?
end

Instance Attribute Details

#descriptionString? (readonly)

User defined description associated with the output.



684
685
686
# File 'cloud_formation/cfn_stack.rb', line 684

def description
  @description
end

#export_nameString? (readonly)

The name of the export associated with the output.



689
690
691
# File 'cloud_formation/cfn_stack.rb', line 689

def export_name
  @export_name
end

#output_keyString? (readonly)

The key associated with the output.



694
695
696
# File 'cloud_formation/cfn_stack.rb', line 694

def output_key
  @output_key
end

#output_valueString? (readonly)

The value associated with the output.



699
700
701
# File 'cloud_formation/cfn_stack.rb', line 699

def output_value
  @output_value
end

Class Method Details

.jsii_propertiesObject



701
702
703
704
705
706
707
708
# File 'cloud_formation/cfn_stack.rb', line 701

def self.jsii_properties
  {
    :description => "description",
    :export_name => "exportName",
    :output_key => "outputKey",
    :output_value => "outputValue",
  }
end

Instance Method Details

#to_jsiiObject



710
711
712
713
714
715
716
717
718
719
# File 'cloud_formation/cfn_stack.rb', line 710

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "exportName" => @export_name,
    "outputKey" => @output_key,
    "outputValue" => @output_value,
  })
  result.compact
end