Package software.amazon.awscdk.services.networkmanager

Class CfnDevice

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.networkmanager.CfnDevice
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.456Z") @Stability(Stable) public class CfnDevice extends CfnResource implements IInspectable
A CloudFormation AWS::NetworkManager::Device.

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
         .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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnDeviceProps props)
      Create a new AWS::NetworkManager::Device.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • 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 .

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags for the device.

    • 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.

    • getDescription

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

      Constraints: Maximum length of 256 characters.

    • setDescription

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

      Constraints: Maximum length of 256 characters.

    • getLocation

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

    • 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.

      Constraints: Maximum length of 128 characters.

    • setModel

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

      Constraints: Maximum length of 128 characters.

    • getSerialNumber

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

      Constraints: Maximum length of 128 characters.

    • setSerialNumber

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

      Constraints: Maximum length of 128 characters.

    • getSiteId

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

    • setSiteId

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

    • 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.

      Constraints: Maximum length of 128 characters.

    • setVendor

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

      Constraints: Maximum length of 128 characters.