Class: AWSCDK::AppConfig::Parameter

Inherits:
Jsii::Object
  • Object
show all
Defined in:
app_config/parameter.rb

Overview

Defines a parameter for an extension.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Parameter

Returns a new instance of Parameter.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'app_config/parameter.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_appconfig.Parameter does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'app_config/parameter.rb', line 12

def self.jsii_overridable_methods
  {
    :is_required => { kind: :property, name: "isRequired", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :value => { kind: :property, name: "value", is_optional: true },
  }
end

.not_required(name, value = nil, description = nil) ⇒ AWSCDK::AppConfig::Parameter

An optional parameter for an extension.

Parameters:

  • name (String) —

    The name of the parameter.

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

    The value of the parameter.

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

    A description for the parameter.

Returns:

  • (AWSCDK::AppConfig::Parameter) 


27
28
29
30
31
32
 
# File 'app_config/parameter.rb', line 27

def self.not_required(name, value = nil, description = nil)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless value.nil?
  Jsii::Type.check_type(description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless description.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Parameter", "notRequired", [name, value, description])
end

.required(name, value, description = nil) ⇒ AWSCDK::AppConfig::Parameter

A required parameter for an extension.

Parameters:

  • name (String) —

    The name of the parameter.

  • value (String) —

    The value of the parameter.

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

    A description for the parameter.

Returns:

  • (AWSCDK::AppConfig::Parameter) 


40
41
42
43
44
45
 
# File 'app_config/parameter.rb', line 40

def self.required(name, value, description = nil)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Type.check_type(description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless description.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.Parameter", "required", [name, value, description])
end

Instance Method Details

#description ⇒ String?

The description of the parameter.

Returns:

  • (String, nil) 


64
65
66
 
# File 'app_config/parameter.rb', line 64

def description()
  jsii_get_property("description")
end

#is_required ⇒ Boolean

A boolean that indicates if the parameter is required or optional.

Returns:

  • (Boolean) 


50
51
52
 
# File 'app_config/parameter.rb', line 50

def is_required()
  jsii_get_property("isRequired")
end

#name ⇒ String

The name of the parameter.

Returns:

  • (String) 


57
58
59
 
# File 'app_config/parameter.rb', line 57

def name()
  jsii_get_property("name")
end

#value ⇒ String?

The value of the parameter.

Returns:

  • (String, nil) 


71
72
73
 
# File 'app_config/parameter.rb', line 71

def value()
  jsii_get_property("value")
end