Class: AWSCDK::OpsWorks::CfnApp::EnvironmentVariableProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ops_works/cfn_app.rb

Overview

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, value:, secure: nil) ⇒ EnvironmentVariableProperty

Returns a new instance of EnvironmentVariableProperty.

Parameters:

  • key (String) —

    (Required) The environment variable's name, which can consist of up to 64 characters and must be specified.

  • value (String) —

    (Optional) The environment variable's value, which can be left empty.

  • secure (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    (Optional) Whether the variable's value is returned by the DescribeApps action.



694
695
696
697
698
699
700
701
 
# File 'ops_works/cfn_app.rb', line 694

def initialize(key:, value:, secure: nil)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  @secure = secure
  Jsii::Type.check_type(@secure, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "secure") unless @secure.nil?
end

Instance Attribute Details

#key ⇒ String (readonly)

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.

The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

Returns:

  • (String)

See Also:



709
710
711
 
# File 'ops_works/cfn_app.rb', line 709

def key
  @key
end

#secure ⇒ Boolean, ... (readonly)

(Optional) Whether the variable's value is returned by the DescribeApps action.

To hide an environment variable's value, set Secure to true . DescribeApps returns *****FILTERED***** instead of the actual value. The default value for Secure is false .

Returns:

See Also:



723
724
725
 
# File 'ops_works/cfn_app.rb', line 723

def secure
  @secure
end

#value ⇒ String (readonly)

(Optional) The environment variable's value, which can be left empty.

If you specify a value, it can contain up to 256 characters, which must all be printable.

Returns:

  • (String)

See Also:



716
717
718
 
# File 'ops_works/cfn_app.rb', line 716

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



725
726
727
728
729
730
731
 
# File 'ops_works/cfn_app.rb', line 725

def self.jsii_properties
  {
    :key => "key",
    :value => "value",
    :secure => "secure",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



733
734
735
736
737
738
739
740
741
 
# File 'ops_works/cfn_app.rb', line 733

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "value" => @value,
    "secure" => @secure,
  })
  result.compact
end