Class: AWSCDK::CfnOutputProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cfn_output_props.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value:, condition: nil, description: nil, export_name: nil, key: nil) ⇒ CfnOutputProps

Returns a new instance of CfnOutputProps.

Parameters:

  • value (String) —

    The value of the property returned by the aws cloudformation describe-stacks command.

  • condition (AWSCDK::CfnCondition, nil) (defaults to: nil) —

    A condition to associate with this output value.

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

    A String type that describes the output value.

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

    The name used to export the value of this output across stacks.

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

    The key of the property returned by aws cloudformation describe-stacks command.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'cfn_output_props.rb', line 11

def initialize(value:, condition: nil, description: nil, export_name: nil, key: nil)
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  @condition = condition
  Jsii::Type.check_type(@condition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5Db25kaXRpb24ifQ==")), "condition") unless @condition.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?
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") unless @key.nil?
end

Instance Attribute Details

#condition ⇒ AWSCDK::CfnCondition? (readonly)

Note:

Default: - No condition is associated with the output.

A condition to associate with this output value.

If the condition evaluates to false, this output value will not be included in the stack.

Returns:



38
39
40
 
# File 'cfn_output_props.rb', line 38

def condition
  @condition
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

A String type that describes the output value.

The description can be a maximum of 4 K in length.

Returns:

  • (String, nil) 


45
46
47
 
# File 'cfn_output_props.rb', line 45

def description
  @description
end

#export_name ⇒ String? (readonly)

Note:

Default: - the output is not exported

The name used to export the value of this output across stacks.

To import the value from another stack, use Fn.importValue(exportName).

Returns:

  • (String, nil) 


52
53
54
 
# File 'cfn_output_props.rb', line 52

def export_name
  @export_name
end

#key ⇒ String? (readonly)

The key of the property returned by aws cloudformation describe-stacks command.

Returns:

  • (String, nil) 


56
57
58
 
# File 'cfn_output_props.rb', line 56

def key
  @key
end

#value ⇒ String (readonly)

The value of the property returned by the aws cloudformation describe-stacks command.

The value of an output can include literals, parameter references, pseudo-parameters, a mapping value, or intrinsic functions.

Returns:

  • (String) 


30
31
32
 
# File 'cfn_output_props.rb', line 30

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'cfn_output_props.rb', line 58

def self.jsii_properties
  {
    :value => "value",
    :condition => "condition",
    :description => "description",
    :export_name => "exportName",
    :key => "key",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'cfn_output_props.rb', line 68

def to_jsii
  result = {}
  result.merge!({
    "value" => @value,
    "condition" => @condition,
    "description" => @description,
    "exportName" => @export_name,
    "key" => @key,
  })
  result.compact
end