Class: AWSCDK::AppMesh::VirtualGatewayProps

Inherits:
VirtualGatewayBaseProps
  • Object
show all
Defined in:
app_mesh/virtual_gateway_props.rb

Overview

Properties used when creating a new VirtualGateway.

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, mesh:) ⇒ VirtualGatewayProps

Returns a new instance of VirtualGatewayProps.

Parameters:



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

def initialize(access_log: nil, backend_defaults: nil, listeners: nil, virtual_gateway_name: nil, mesh:)
  @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?
  @mesh = mesh
  Jsii::Type.check_type(@mesh, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5JTWVzaCJ9")), "mesh")
end

Instance Attribute Details

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

Note:

Default: - no access logging

Access Logging Configuration for the VirtualGateway.

Returns:



29
30
31
 
# File 'app_mesh/virtual_gateway_props.rb', line 29

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:



34
35
36
 
# File 'app_mesh/virtual_gateway_props.rb', line 34

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:



41
42
43
 
# File 'app_mesh/virtual_gateway_props.rb', line 41

def listeners
  @listeners
end

#mesh ⇒ AWSCDK::AppMesh::IMesh (readonly)

The Mesh which the VirtualGateway belongs to.

Returns:



50
51
52
 
# File 'app_mesh/virtual_gateway_props.rb', line 50

def mesh
  @mesh
end

#virtual_gateway_name ⇒ String? (readonly)

Note:

Default: - A name is automatically determined

Name of the VirtualGateway.

Returns:

  • (String, nil) 


46
47
48
 
# File 'app_mesh/virtual_gateway_props.rb', line 46

def virtual_gateway_name
  @virtual_gateway_name
end

Class Method Details

.jsii_properties ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'app_mesh/virtual_gateway_props.rb', line 52

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

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'app_mesh/virtual_gateway_props.rb', line 62

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