Class: AWSCDK::AppConfig::ExtensionOptions

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

Overview

Options for the Extension construct.

Direct Known Subclasses

ExtensionProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, extension_name: nil, latest_version_number: nil, parameters: nil) ⇒ ExtensionOptions

Returns a new instance of ExtensionOptions.

Parameters:

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

    A description of the extension.

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

    The name of the extension.

  • latest_version_number (Numeric, nil) (defaults to: nil) —

    The latest version number of the extension.

  • parameters (Array<AWSCDK::AppConfig::Parameter>, nil) (defaults to: nil) —

    The parameters accepted for the extension.



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

def initialize(description: nil, extension_name: nil, latest_version_number: nil, parameters: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @extension_name = extension_name
  Jsii::Type.check_type(@extension_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "extensionName") unless @extension_name.nil?
  @latest_version_number = latest_version_number
  Jsii::Type.check_type(@latest_version_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "latestVersionNumber") unless @latest_version_number.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBjb25maWcuUGFyYW1ldGVyIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "parameters") unless @parameters.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: - No description.

A description of the extension.

Returns:

  • (String, nil) 


26
27
28
 
# File 'app_config/extension_options.rb', line 26

def description
  @description
end

#extension_name ⇒ String? (readonly)

Note:

Default: - A name is generated.

The name of the extension.

Returns:

  • (String, nil) 


31
32
33
 
# File 'app_config/extension_options.rb', line 31

def extension_name
  @extension_name
end

#latest_version_number ⇒ Numeric? (readonly)

Note:

Default: - None.

The latest version number of the extension.

When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

Returns:

  • (Numeric, nil) 


40
41
42
 
# File 'app_config/extension_options.rb', line 40

def latest_version_number
  @latest_version_number
end

#parameters ⇒ Array<AWSCDK::AppConfig::Parameter>? (readonly)

Note:

Default: - None.

The parameters accepted for the extension.

Returns:



45
46
47
 
# File 'app_config/extension_options.rb', line 45

def parameters
  @parameters
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'app_config/extension_options.rb', line 47

def self.jsii_properties
  {
    :description => "description",
    :extension_name => "extensionName",
    :latest_version_number => "latestVersionNumber",
    :parameters => "parameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'app_config/extension_options.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "extensionName" => @extension_name,
    "latestVersionNumber" => @latest_version_number,
    "parameters" => @parameters,
  })
  result.compact
end