Class: AWSCDK::AppConfig::ExtensionProps

Inherits:
ExtensionOptions
  • Object
show all
Defined in:
app_config/extension_props.rb

Overview

Properties for the Extension construct.

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, actions:) ⇒ ExtensionProps

Returns a new instance of ExtensionProps.

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.

  • actions (Array<AWSCDK::AppConfig::Action>) —

    The actions for the extension.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'app_config/extension_props.rb', line 12

def initialize(description: nil, extension_name: nil, latest_version_number: nil, parameters: nil, actions:)
  @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?
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBjb25maWcuQWN0aW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "actions")
end

Instance Attribute Details

#actions ⇒ Array<AWSCDK::AppConfig::Action> (readonly)

The actions for the extension.

Returns:



52
53
54
 
# File 'app_config/extension_props.rb', line 52

def actions
  @actions
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

A description of the extension.

Returns:

  • (String, nil) 


29
30
31
 
# File 'app_config/extension_props.rb', line 29

def description
  @description
end

#extension_name ⇒ String? (readonly)

Note:

Default: - A name is generated.

The name of the extension.

Returns:

  • (String, nil) 


34
35
36
 
# File 'app_config/extension_props.rb', line 34

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) 


43
44
45
 
# File 'app_config/extension_props.rb', line 43

def latest_version_number
  @latest_version_number
end

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

Note:

Default: - None.

The parameters accepted for the extension.

Returns:



48
49
50
 
# File 'app_config/extension_props.rb', line 48

def parameters
  @parameters
end

Class Method Details

.jsii_properties ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'app_config/extension_props.rb', line 54

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

Instance Method Details

#to_jsii ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'app_config/extension_props.rb', line 64

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