CfnDeviceProps

class aws_cdk.aws_networkmanager.CfnDeviceProps(*, global_network_id, description=None, location=None, model=None, serial_number=None, site_id=None, tags=None, type=None, vendor=None)

Bases: object

Properties for defining a CfnDevice.

Parameters
  • global_network_id (str) – The ID of the global network.

  • description (Optional[str]) – A description of the device. Constraints: Maximum length of 256 characters.

  • location (Union[IResolvable, LocationProperty, None]) – The site location.

  • model (Optional[str]) – The model of the device. Constraints: Maximum length of 128 characters.

  • serial_number (Optional[str]) – The serial number of the device. Constraints: Maximum length of 128 characters.

  • site_id (Optional[str]) – The site ID.

  • tags (Optional[Sequence[CfnTag]]) – The tags for the device.

  • type (Optional[str]) – The device type.

  • vendor (Optional[str]) – The vendor of the device. Constraints: Maximum length of 128 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_networkmanager as networkmanager

cfn_device_props = networkmanager.CfnDeviceProps(
    global_network_id="globalNetworkId",

    # the properties below are optional
    description="description",
    location=networkmanager.CfnDevice.LocationProperty(
        address="address",
        latitude="latitude",
        longitude="longitude"
    ),
    model="model",
    serial_number="serialNumber",
    site_id="siteId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type",
    vendor="vendor"
)

Attributes

description

A description of the device.

Constraints: Maximum length of 256 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-description

Return type

Optional[str]

global_network_id

The ID of the global network.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-globalnetworkid

Return type

str

location

The site location.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-location

Return type

Union[IResolvable, LocationProperty, None]

model

The model of the device.

Constraints: Maximum length of 128 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-model

Return type

Optional[str]

serial_number

The serial number of the device.

Constraints: Maximum length of 128 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-serialnumber

Return type

Optional[str]

site_id

The site ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-siteid

Return type

Optional[str]

tags

The tags for the device.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-tags

Return type

Optional[List[CfnTag]]

type

The device type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-type

Return type

Optional[str]

vendor

The vendor of the device.

Constraints: Maximum length of 128 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkmanager-device.html#cfn-networkmanager-device-vendor

Return type

Optional[str]