Class: AWSCDK::IoTWireless::CfnNetworkAnalyzerConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_wireless/cfn_network_analyzer_configuration_props.rb

Overview

Properties for defining a CfnNetworkAnalyzerConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, description: nil, tags: nil, trace_content: nil, wireless_devices: nil, wireless_gateways: nil) ⇒ CfnNetworkAnalyzerConfigurationProps

Returns a new instance of CfnNetworkAnalyzerConfigurationProps.

Parameters:

  • name (String) —

    Name of the network analyzer configuration.

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

    The description of the resource.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags to attach to the specified resource.

  • trace_content (Object, nil) (defaults to: nil) —

    Trace content for your wireless gateway and wireless device resources.

  • wireless_devices (Array<String>, nil) (defaults to: nil) —

    Wireless device resources to add to the network analyzer configuration.

  • wireless_gateways (Array<String>, nil) (defaults to: nil) —

    Wireless gateway resources to add to the network analyzer configuration.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 15

def initialize(name:, description: nil, tags: nil, trace_content: nil, wireless_devices: nil, wireless_gateways: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @trace_content = trace_content
  Jsii::Type.check_type(@trace_content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "traceContent") unless @trace_content.nil?
  @wireless_devices = wireless_devices
  Jsii::Type.check_type(@wireless_devices, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "wirelessDevices") unless @wireless_devices.nil?
  @wireless_gateways = wireless_gateways
  Jsii::Type.check_type(@wireless_gateways, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "wirelessGateways") unless @wireless_gateways.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the resource.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 39

def description
  @description
end

#name ⇒ String (readonly)

Name of the network analyzer configuration.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 34

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to attach to the specified resource.

Tags are metadata that you can use to manage a resource.

Returns:

See Also:



46
47
48
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 46

def tags
  @tags
end

#trace_content ⇒ Object? (readonly)

Trace content for your wireless gateway and wireless device resources.

Returns:

  • (Object, nil)

See Also:



51
52
53
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 51

def trace_content
  @trace_content
end

#wireless_devices ⇒ Array<String>? (readonly)

Wireless device resources to add to the network analyzer configuration.

Provide the WirelessDeviceId of the resource to add in the input array.

Returns:

  • (Array<String>, nil)

See Also:



58
59
60
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 58

def wireless_devices
  @wireless_devices
end

#wireless_gateways ⇒ Array<String>? (readonly)

Wireless gateway resources to add to the network analyzer configuration.

Provide the WirelessGatewayId of the resource to add in the input array.

Returns:

  • (Array<String>, nil)

See Also:



65
66
67
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 65

def wireless_gateways
  @wireless_gateways
end

Class Method Details

.jsii_properties ⇒ Object 



67
68
69
70
71
72
73
74
75
76
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 67

def self.jsii_properties
  {
    :name => "name",
    :description => "description",
    :tags => "tags",
    :trace_content => "traceContent",
    :wireless_devices => "wirelessDevices",
    :wireless_gateways => "wirelessGateways",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'io_t_wireless/cfn_network_analyzer_configuration_props.rb', line 78

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "description" => @description,
    "tags" => @tags,
    "traceContent" => @trace_content,
    "wirelessDevices" => @wireless_devices,
    "wirelessGateways" => @wireless_gateways,
  })
  result.compact
end