Class: AWSCDK::AppMesh::VirtualGatewayBaseProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_mesh/virtual_gateway_base_props.rb

Overview

Basic configuration properties for a VirtualGateway.

Direct Known Subclasses

VirtualGatewayProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_log: nil, backend_defaults: nil, listeners: nil, virtual_gateway_name: nil) ⇒ VirtualGatewayBaseProps

Returns a new instance of VirtualGatewayBaseProps.

Parameters:

  • access_log (AWSCDK::AppMesh::AccessLog, nil) (defaults to: nil) —

    Access Logging Configuration for the VirtualGateway.

  • backend_defaults (AWSCDK::AppMesh::BackendDefaults, nil) (defaults to: nil) —

    Default Configuration Virtual Node uses to communicate with Virtual Service.

  • listeners (Array<AWSCDK::AppMesh::VirtualGatewayListener>, nil) (defaults to: nil) —

    Listeners for the VirtualGateway.

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

    Name of the VirtualGateway.



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

def initialize(access_log: nil, backend_defaults: nil, listeners: nil, virtual_gateway_name: nil)
  @access_log = access_log
  Jsii::Type.check_type(@access_log, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5BY2Nlc3NMb2cifQ==")), "accessLog") unless @access_log.nil?
  @backend_defaults = backend_defaults.is_a?(Hash) ? ::AWSCDK::AppMesh::BackendDefaults.new(**backend_defaults.transform_keys(&:to_sym)) : backend_defaults
  Jsii::Type.check_type(@backend_defaults, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5CYWNrZW5kRGVmYXVsdHMifQ==")), "backendDefaults") unless @backend_defaults.nil?
  @listeners = listeners
  Jsii::Type.check_type(@listeners, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBtZXNoLlZpcnR1YWxHYXRld2F5TGlzdGVuZXIifSwia2luZCI6ImFycmF5In19")), "listeners") unless @listeners.nil?
  @virtual_gateway_name = virtual_gateway_name
  Jsii::Type.check_type(@virtual_gateway_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualGatewayName") unless @virtual_gateway_name.nil?
end

Instance Attribute Details

#access_log ⇒ AWSCDK::AppMesh::AccessLog? (readonly)

Note:

Default: - no access logging

Access Logging Configuration for the VirtualGateway.

Returns:



26
27
28
 
# File 'app_mesh/virtual_gateway_base_props.rb', line 26

def access_log
  @access_log
end

#backend_defaults ⇒ AWSCDK::AppMesh::BackendDefaults? (readonly)

Note:

Default: - No Config

Default Configuration Virtual Node uses to communicate with Virtual Service.

Returns:



31
32
33
 
# File 'app_mesh/virtual_gateway_base_props.rb', line 31

def backend_defaults
  @backend_defaults
end

#listeners ⇒ Array<AWSCDK::AppMesh::VirtualGatewayListener>? (readonly)

Note:

Default: - Single HTTP listener on port 8080

Listeners for the VirtualGateway.

Only one is supported.

Returns:



38
39
40
 
# File 'app_mesh/virtual_gateway_base_props.rb', line 38

def listeners
  @listeners
end

#virtual_gateway_name ⇒ String? (readonly)

Note:

Default: - A name is automatically determined

Name of the VirtualGateway.

Returns:

  • (String, nil) 


43
44
45
 
# File 'app_mesh/virtual_gateway_base_props.rb', line 43

def virtual_gateway_name
  @virtual_gateway_name
end

Class Method Details

.jsii_properties ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'app_mesh/virtual_gateway_base_props.rb', line 45

def self.jsii_properties
  {
    :access_log => "accessLog",
    :backend_defaults => "backendDefaults",
    :listeners => "listeners",
    :virtual_gateway_name => "virtualGatewayName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'app_mesh/virtual_gateway_base_props.rb', line 54

def to_jsii
  result = {}
  result.merge!({
    "accessLog" => @access_log,
    "backendDefaults" => @backend_defaults,
    "listeners" => @listeners,
    "virtualGatewayName" => @virtual_gateway_name,
  })
  result.compact
end