Class: AWSCDK::NetworkManager::CfnDeviceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
network_manager/cfn_device_props.rb

Overview

Properties for defining a CfnDevice.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(global_network_id:, aws_location: nil, description: nil, location: nil, model: nil, serial_number: nil, site_id: nil, tags: nil, type: nil, vendor: nil) ⇒ CfnDeviceProps

Returns a new instance of CfnDeviceProps.

Parameters:

  • global_network_id (String) —

    The ID of the global network.

  • aws_location (AWSCDK::IResolvable, AWSCDK::NetworkManager::CfnDevice::AWSLocationProperty, nil) (defaults to: nil) —

    The AWS location of the device.

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

    A description of the device.

  • location (AWSCDK::IResolvable, AWSCDK::NetworkManager::CfnDevice::LocationProperty, nil) (defaults to: nil) —

    The site location.

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

    The model of the device.

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

    The serial number of the device.

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

    The site ID.

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

    The tags for the device.

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

    The device type.

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

    The vendor of the device.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'network_manager/cfn_device_props.rb', line 19

def initialize(global_network_id:, aws_location: nil, description: nil, location: nil, model: nil, serial_number: nil, site_id: nil, tags: nil, type: nil, vendor: nil)
  @global_network_id = global_network_id
  Jsii::Type.check_type(@global_network_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalNetworkId")
  @aws_location = aws_location.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnDevice::AWSLocationProperty.new(**aws_location.transform_keys(&:to_sym)) : aws_location
  Jsii::Type.check_type(@aws_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5EZXZpY2UuQVdTTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "awsLocation") unless @aws_location.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @location = location.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnDevice::LocationProperty.new(**location.transform_keys(&:to_sym)) : location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5EZXZpY2UuTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "location") unless @location.nil?
  @model = model
  Jsii::Type.check_type(@model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "model") unless @model.nil?
  @serial_number = serial_number
  Jsii::Type.check_type(@serial_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serialNumber") unless @serial_number.nil?
  @site_id = site_id
  Jsii::Type.check_type(@site_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "siteId") unless @site_id.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?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
  @vendor = vendor
  Jsii::Type.check_type(@vendor, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vendor") unless @vendor.nil?
end

Instance Attribute Details

#aws_location ⇒ AWSCDK::IResolvable, ... (readonly)

The AWS location of the device.

Returns:

See Also:



51
52
53
 
# File 'network_manager/cfn_device_props.rb', line 51

def aws_location
  @aws_location
end

#description ⇒ String? (readonly)

A description of the device.

Constraints: Maximum length of 256 characters.

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'network_manager/cfn_device_props.rb', line 58

def description
  @description
end

#global_network_id ⇒ String (readonly)

The ID of the global network.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'network_manager/cfn_device_props.rb', line 46

def global_network_id
  @global_network_id
end

#location ⇒ AWSCDK::IResolvable, ... (readonly)

The site location.

Returns:

See Also:



63
64
65
 
# File 'network_manager/cfn_device_props.rb', line 63

def location
  @location
end

#model ⇒ String? (readonly)

The model of the device.

Constraints: Maximum length of 128 characters.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'network_manager/cfn_device_props.rb', line 70

def model
  @model
end

#serial_number ⇒ String? (readonly)

The serial number of the device.

Constraints: Maximum length of 128 characters.

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'network_manager/cfn_device_props.rb', line 77

def serial_number
  @serial_number
end

#site_id ⇒ String? (readonly)

The site ID.

Returns:

  • (String, nil)

See Also:



82
83
84
 
# File 'network_manager/cfn_device_props.rb', line 82

def site_id
  @site_id
end

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

The tags for the device.

Returns:

See Also:



87
88
89
 
# File 'network_manager/cfn_device_props.rb', line 87

def tags
  @tags
end

#type ⇒ String? (readonly)

The device type.

Returns:

  • (String, nil)

See Also:



92
93
94
 
# File 'network_manager/cfn_device_props.rb', line 92

def type
  @type
end

#vendor ⇒ String? (readonly)

The vendor of the device.

Constraints: Maximum length of 128 characters.

Returns:

  • (String, nil)

See Also:



99
100
101
 
# File 'network_manager/cfn_device_props.rb', line 99

def vendor
  @vendor
end

Class Method Details

.jsii_properties ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'network_manager/cfn_device_props.rb', line 101

def self.jsii_properties
  {
    :global_network_id => "globalNetworkId",
    :aws_location => "awsLocation",
    :description => "description",
    :location => "location",
    :model => "model",
    :serial_number => "serialNumber",
    :site_id => "siteId",
    :tags => "tags",
    :type => "type",
    :vendor => "vendor",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'network_manager/cfn_device_props.rb', line 116

def to_jsii
  result = {}
  result.merge!({
    "globalNetworkId" => @global_network_id,
    "awsLocation" => @aws_location,
    "description" => @description,
    "location" => @location,
    "model" => @model,
    "serialNumber" => @serial_number,
    "siteId" => @site_id,
    "tags" => @tags,
    "type" => @type,
    "vendor" => @vendor,
  })
  result.compact
end