Class: AWSCDK::NetworkManager::CfnDevice

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSNetworkmanager::IDeviceRef
Defined in:
network_manager/cfn_device.rb

Overview

Specifies a device.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDevice

Create a new AWS::NetworkManager::Device.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::NetworkManager::CfnDeviceProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'network_manager/cfn_device.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnDeviceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbmV0d29ya21hbmFnZXIuQ2ZuRGV2aWNlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_device(resource) ⇒ String

Parameters:

Returns:

  • (String) 


84
85
86
87
 
# File 'network_manager/cfn_device.rb', line 84

def self.arn_for_device(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19uZXR3b3JrbWFuYWdlci5JRGV2aWNlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnDevice", "arnForDevice", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


191
192
193
 
# File 'network_manager/cfn_device.rb', line 191

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_networkmanager.CfnDevice", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_device(x) ⇒ Boolean

Checks whether the given object is a CfnDevice.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


93
94
95
96
 
# File 'network_manager/cfn_device.rb', line 93

def self.is_cfn_device(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnDevice", "isCfnDevice", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'network_manager/cfn_device.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_device_arn => { kind: :property, name: "attrDeviceArn", is_optional: false },
    :attr_device_id => { kind: :property, name: "attrDeviceId", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :device_ref => { kind: :property, name: "deviceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :global_network_id => { kind: :property, name: "globalNetworkId", is_optional: false },
    :aws_location => { kind: :property, name: "awsLocation", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :location => { kind: :property, name: "location", is_optional: true },
    :model => { kind: :property, name: "model", is_optional: true },
    :serial_number => { kind: :property, name: "serialNumber", is_optional: true },
    :site_id => { kind: :property, name: "siteId", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :vendor => { kind: :property, name: "vendor", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



400
401
402
403
 
# File 'network_manager/cfn_device.rb', line 400

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



412
413
414
415
 
# File 'network_manager/cfn_device.rb', line 412

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



422
423
424
425
 
# File 'network_manager/cfn_device.rb', line 422

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



433
434
435
436
437
 
# File 'network_manager/cfn_device.rb', line 433

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


490
491
492
493
494
 
# File 'network_manager/cfn_device.rb', line 490

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



500
501
502
503
 
# File 'network_manager/cfn_device.rb', line 500

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



512
513
514
515
516
 
# File 'network_manager/cfn_device.rb', line 512

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



525
526
527
528
 
# File 'network_manager/cfn_device.rb', line 525

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



547
548
549
550
551
552
 
# File 'network_manager/cfn_device.rb', line 547

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

The time that the device was created.

Returns:

  • (String) 


198
199
200
 
# File 'network_manager/cfn_device.rb', line 198

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_device_arn ⇒ String

The ARN of the device.

For example, arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 .

Returns:

  • (String) 


207
208
209
 
# File 'network_manager/cfn_device.rb', line 207

def attr_device_arn()
  jsii_get_property("attrDeviceArn")
end

#attr_device_id ⇒ String

The ID of the device.

For example, device-07f6fd08867abc123 .

Returns:

  • (String) 


216
217
218
 
# File 'network_manager/cfn_device.rb', line 216

def attr_device_id()
  jsii_get_property("attrDeviceId")
end

#attr_state ⇒ String

The state of the device.

Returns:

  • (String) 


223
224
225
 
# File 'network_manager/cfn_device.rb', line 223

def attr_state()
  jsii_get_property("attrState")
end

#aws_location ⇒ AWSCDK::IResolvable, ...

The AWS location of the device.

Returns:



256
257
258
 
# File 'network_manager/cfn_device.rb', line 256

def aws_location()
  jsii_get_property("awsLocation")
end

#aws_location=(value) ⇒ Object 



260
261
262
263
264
 
# File 'network_manager/cfn_device.rb', line 260

def aws_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnDevice::AWSLocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5EZXZpY2UuQVdTTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "awsLocation") unless value.nil?
  jsii_set_property("awsLocation", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



144
145
146
 
# File 'network_manager/cfn_device.rb', line 144

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


149
150
151
 
# File 'network_manager/cfn_device.rb', line 149

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


556
557
558
559
 
# File 'network_manager/cfn_device.rb', line 556

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


154
155
156
 
# File 'network_manager/cfn_device.rb', line 154

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


161
162
163
 
# File 'network_manager/cfn_device.rb', line 161

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


106
107
108
 
# File 'network_manager/cfn_device.rb', line 106

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description of the device.

Returns:

  • (String, nil) 


269
270
271
 
# File 'network_manager/cfn_device.rb', line 269

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



273
274
275
276
 
# File 'network_manager/cfn_device.rb', line 273

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#device_ref ⇒ AWSCDK::Interfaces::AWSNetworkmanager::DeviceReference

A reference to a Device resource.

Returns:



230
231
232
 
# File 'network_manager/cfn_device.rb', line 230

def device_ref()
  jsii_get_property("deviceRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



166
167
168
 
# File 'network_manager/cfn_device.rb', line 166

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



569
570
571
572
573
 
# File 'network_manager/cfn_device.rb', line 569

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



580
581
582
583
 
# File 'network_manager/cfn_device.rb', line 580

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#global_network_id ⇒ String

The ID of the global network.

Returns:

  • (String) 


244
245
246
 
# File 'network_manager/cfn_device.rb', line 244

def global_network_id()
  jsii_get_property("globalNetworkId")
end

#global_network_id=(value) ⇒ Object 



248
249
250
251
 
# File 'network_manager/cfn_device.rb', line 248

def global_network_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "globalNetworkId")
  jsii_set_property("globalNetworkId", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



650
651
652
653
 
# File 'network_manager/cfn_device.rb', line 650

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#location ⇒ AWSCDK::IResolvable, ...

The site location.

Returns:



281
282
283
 
# File 'network_manager/cfn_device.rb', line 281

def location()
  jsii_get_property("location")
end

#location=(value) ⇒ Object 



285
286
287
288
289
 
# File 'network_manager/cfn_device.rb', line 285

def location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnDevice::LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5EZXZpY2UuTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "location") unless value.nil?
  jsii_set_property("location", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


118
119
120
 
# File 'network_manager/cfn_device.rb', line 118

def logical_id()
  jsii_get_property("logicalId")
end

#model ⇒ String?

The model of the device.

Returns:

  • (String, nil) 


294
295
296
 
# File 'network_manager/cfn_device.rb', line 294

def model()
  jsii_get_property("model")
end

#model=(value) ⇒ Object 



298
299
300
301
 
# File 'network_manager/cfn_device.rb', line 298

def model=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "model") unless value.nil?
  jsii_set_property("model", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


101
102
103
 
# File 'network_manager/cfn_device.rb', line 101

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



591
592
593
 
# File 'network_manager/cfn_device.rb', line 591

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



598
599
600
 
# File 'network_manager/cfn_device.rb', line 598

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



391
392
393
394
 
# File 'network_manager/cfn_device.rb', line 391

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


137
138
139
 
# File 'network_manager/cfn_device.rb', line 137

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



609
610
611
612
 
# File 'network_manager/cfn_device.rb', line 609

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


616
617
618
619
 
# File 'network_manager/cfn_device.rb', line 616

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



626
627
628
629
630
 
# File 'network_manager/cfn_device.rb', line 626

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#serial_number ⇒ String?

The serial number of the device.

Returns:

  • (String, nil) 


306
307
308
 
# File 'network_manager/cfn_device.rb', line 306

def serial_number()
  jsii_get_property("serialNumber")
end

#serial_number=(value) ⇒ Object 



310
311
312
313
 
# File 'network_manager/cfn_device.rb', line 310

def serial_number=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serialNumber") unless value.nil?
  jsii_set_property("serialNumber", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



635
636
637
 
# File 'network_manager/cfn_device.rb', line 635

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#site_id ⇒ String?

The site ID.

Returns:

  • (String, nil) 


318
319
320
 
# File 'network_manager/cfn_device.rb', line 318

def site_id()
  jsii_get_property("siteId")
end

#site_id=(value) ⇒ Object 



322
323
324
325
 
# File 'network_manager/cfn_device.rb', line 322

def site_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "siteId") unless value.nil?
  jsii_set_property("siteId", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



127
128
129
 
# File 'network_manager/cfn_device.rb', line 127

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



237
238
239
 
# File 'network_manager/cfn_device.rb', line 237

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for the device.

Returns:



330
331
332
 
# File 'network_manager/cfn_device.rb', line 330

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



334
335
336
337
338
 
# File 'network_manager/cfn_device.rb', line 334

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



367
368
369
 
# File 'network_manager/cfn_device.rb', line 367

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ String?

The device type.

Returns:

  • (String, nil) 


343
344
345
 
# File 'network_manager/cfn_device.rb', line 343

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



347
348
349
350
 
# File 'network_manager/cfn_device.rb', line 347

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


174
175
176
 
# File 'network_manager/cfn_device.rb', line 174

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


184
185
186
 
# File 'network_manager/cfn_device.rb', line 184

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


641
642
643
644
 
# File 'network_manager/cfn_device.rb', line 641

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vendor ⇒ String?

The vendor of the device.

Returns:

  • (String, nil) 


355
356
357
 
# File 'network_manager/cfn_device.rb', line 355

def vendor()
  jsii_get_property("vendor")
end

#vendor=(value) ⇒ Object 



359
360
361
362
 
# File 'network_manager/cfn_device.rb', line 359

def vendor=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vendor") unless value.nil?
  jsii_set_property("vendor", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


380
381
382
383
384
385
 
# File 'network_manager/cfn_device.rb', line 380

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end