Package software.amazon.awscdk.services.networkmanager

Class CfnDevice

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.networkmanager.CfnDevice
All Implemented Interfaces:
IInspectable, ITaggable, IDeviceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.031Z") @Stability(Stable) public class CfnDevice extends CfnResource implements IInspectable, IDeviceRef, ITaggable
Specifies a device.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkmanager.*;
 CfnDevice cfnDevice = CfnDevice.Builder.create(this, "MyCfnDevice")
         .globalNetworkId("globalNetworkId")
         // the properties below are optional
         .awsLocation(AWSLocationProperty.builder()
                 .subnetArn("subnetArn")
                 .zone("zone")
                 .build())
         .description("description")
         .location(LocationProperty.builder()
                 .address("address")
                 .latitude("latitude")
                 .longitude("longitude")
                 .build())
         .model("model")
         .serialNumber("serialNumber")
         .siteId("siteId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .vendor("vendor")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDevice

      protected CfnDevice(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDevice

      protected CfnDevice(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDevice

      @Stability(Stable) public CfnDevice(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDeviceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time that the device was created.

    • getAttrDeviceArn

      @Stability(Stable) @NotNull public String getAttrDeviceArn()
      The ARN of the device.

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

    • getAttrDeviceId

      @Stability(Stable) @NotNull public String getAttrDeviceId()
      The ID of the device.

      For example, device-07f6fd08867abc123 .

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the device.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDeviceRef

      @Stability(Stable) @NotNull public DeviceReference getDeviceRef()
      A reference to a Device resource.
      Specified by:
      getDeviceRef in interface IDeviceRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getGlobalNetworkId

      @Stability(Stable) @NotNull public String getGlobalNetworkId()
      The ID of the global network.

    • setGlobalNetworkId

      @Stability(Stable) public void setGlobalNetworkId(@NotNull String value)
      The ID of the global network.

    • getAwsLocation

      @Stability(Stable) @Nullable public Object getAwsLocation()
      The AWS location of the device.

      Returns union: either IResolvable or CfnDevice.AWSLocationProperty

    • setAwsLocation

      @Stability(Stable) public void setAwsLocation(@Nullable IResolvable value)
      The AWS location of the device.

    • setAwsLocation

      @Stability(Stable) public void setAwsLocation(@Nullable CfnDevice.AWSLocationProperty value)
      The AWS location of the device.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the device.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the device.

    • getLocation

      @Stability(Stable) @Nullable public Object getLocation()
      The site location.

      Returns union: either IResolvable or CfnDevice.LocationProperty

    • setLocation

      @Stability(Stable) public void setLocation(@Nullable IResolvable value)
      The site location.

    • setLocation

      @Stability(Stable) public void setLocation(@Nullable CfnDevice.LocationProperty value)
      The site location.

    • getModel

      @Stability(Stable) @Nullable public String getModel()
      The model of the device.

    • setModel

      @Stability(Stable) public void setModel(@Nullable String value)
      The model of the device.

    • getSerialNumber

      @Stability(Stable) @Nullable public String getSerialNumber()
      The serial number of the device.

    • setSerialNumber

      @Stability(Stable) public void setSerialNumber(@Nullable String value)
      The serial number of the device.

    • getSiteId

      @Stability(Stable) @Nullable public String getSiteId()
      The site ID.

    • setSiteId

      @Stability(Stable) public void setSiteId(@Nullable String value)
      The site ID.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for the device.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for the device.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The device type.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The device type.

    • getVendor

      @Stability(Stable) @Nullable public String getVendor()
      The vendor of the device.

    • setVendor

      @Stability(Stable) public void setVendor(@Nullable String value)
      The vendor of the device.