Class: AWSCDK::AppMesh::VirtualNodeBaseProps

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

Overview

Basic configuration properties for a VirtualNode.

Direct Known Subclasses

VirtualNodeProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_log: nil, backend_defaults: nil, backends: nil, listeners: nil, service_discovery: nil, virtual_node_name: nil) ⇒ VirtualNodeBaseProps

Returns a new instance of VirtualNodeBaseProps.

Parameters:

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

    Access Logging Configuration for the virtual node.

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

    Default Configuration Virtual Node uses to communicate with Virtual Service.

  • backends (Array<AWSCDK::AppMesh::Backend>, nil) (defaults to: nil) —

    Virtual Services that this is node expected to send outbound traffic to.

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

    Initial listener for the virtual node.

  • service_discovery (AWSCDK::AppMesh::ServiceDiscovery, nil) (defaults to: nil) —

    Defines how upstream clients will discover this VirtualNode.

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

    The name of the VirtualNode.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'app_mesh/virtual_node_base_props.rb', line 13

def initialize(access_log: nil, backend_defaults: nil, backends: nil, listeners: nil, service_discovery: nil, virtual_node_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?
  @backends = backends
  Jsii::Type.check_type(@backends, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBtZXNoLkJhY2tlbmQifSwia2luZCI6ImFycmF5In19")), "backends") unless @backends.nil?
  @listeners = listeners
  Jsii::Type.check_type(@listeners, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBtZXNoLlZpcnR1YWxOb2RlTGlzdGVuZXIifSwia2luZCI6ImFycmF5In19")), "listeners") unless @listeners.nil?
  @service_discovery = service_discovery
  Jsii::Type.check_type(@service_discovery, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5TZXJ2aWNlRGlzY292ZXJ5In0=")), "serviceDiscovery") unless @service_discovery.nil?
  @virtual_node_name = virtual_node_name
  Jsii::Type.check_type(@virtual_node_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualNodeName") unless @virtual_node_name.nil?
end

Instance Attribute Details

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

Note:

Default: - No access logging

Access Logging Configuration for the virtual node.

Returns:



32
33
34
 
# File 'app_mesh/virtual_node_base_props.rb', line 32

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:



37
38
39
 
# File 'app_mesh/virtual_node_base_props.rb', line 37

def backend_defaults
  @backend_defaults
end

#backends ⇒ Array<AWSCDK::AppMesh::Backend>? (readonly)

Note:

Default: - No backends

Virtual Services that this is node expected to send outbound traffic to.

Returns:



42
43
44
 
# File 'app_mesh/virtual_node_base_props.rb', line 42

def backends
  @backends
end

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

Note:

Default: - No listeners

Initial listener for the virtual node.

Returns:



47
48
49
 
# File 'app_mesh/virtual_node_base_props.rb', line 47

def listeners
  @listeners
end

#service_discovery ⇒ AWSCDK::AppMesh::ServiceDiscovery? (readonly)

Note:

Default: - No Service Discovery

Defines how upstream clients will discover this VirtualNode.

Returns:



52
53
54
 
# File 'app_mesh/virtual_node_base_props.rb', line 52

def service_discovery
  @service_discovery
end

#virtual_node_name ⇒ String? (readonly)

Note:

Default: - A name is automatically determined

The name of the VirtualNode.

Returns:

  • (String, nil) 


57
58
59
 
# File 'app_mesh/virtual_node_base_props.rb', line 57

def virtual_node_name
  @virtual_node_name
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'app_mesh/virtual_node_base_props.rb', line 59

def self.jsii_properties
  {
    :access_log => "accessLog",
    :backend_defaults => "backendDefaults",
    :backends => "backends",
    :listeners => "listeners",
    :service_discovery => "serviceDiscovery",
    :virtual_node_name => "virtualNodeName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'app_mesh/virtual_node_base_props.rb', line 70

def to_jsii
  result = {}
  result.merge!({
    "accessLog" => @access_log,
    "backendDefaults" => @backend_defaults,
    "backends" => @backends,
    "listeners" => @listeners,
    "serviceDiscovery" => @service_discovery,
    "virtualNodeName" => @virtual_node_name,
  })
  result.compact
end