software.amazon.awscdk.services.networkmanager

Class CfnDevice

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.566Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDevice.Builder A fluent builder for CfnDevice.
static interface	CfnDevice.LocationProperty Describes a location.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDevice(Construct scope, java.lang.String id, CfnDeviceProps props) Create a new `AWS::NetworkManager::Device`.
protected	CfnDevice(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDevice(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrDeviceArn() The ARN of the device.
java.lang.String	getAttrDeviceId() The ID of the device.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the device.
java.lang.String	getGlobalNetworkId() The ID of the global network.
java.lang.Object	getLocation() The site location.
java.lang.String	getModel() The model of the device.
java.lang.String	getSerialNumber() The serial number of the device.
java.lang.String	getSiteId() The site ID.
TagManager	getTags() The tags for the device.
java.lang.String	getType() The device type.
java.lang.String	getVendor() The vendor of the device.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description of the device.
void	setGlobalNetworkId(java.lang.String value) The ID of the global network.
void	setLocation(CfnDevice.LocationProperty value) The site location.
void	setLocation(IResolvable value) The site location.
void	setModel(java.lang.String value) The model of the device.
void	setSerialNumber(java.lang.String value) The serial number of the device.
void	setSiteId(java.lang.String value) The site ID.
void	setType(java.lang.String value) The device type.
void	setVendor(java.lang.String value) The vendor of the device.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDevice

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

CfnDevice

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

CfnDevice

public CfnDevice(Construct scope,
                 java.lang.String id,
                 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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDeviceArn

public java.lang.String getAttrDeviceArn()

The ARN of the device.

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

getAttrDeviceId

public java.lang.String getAttrDeviceId()

The ID of the device.

For example, device-07f6fd08867abc123 .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags for the device.

getGlobalNetworkId

public java.lang.String getGlobalNetworkId()

The ID of the global network.

setGlobalNetworkId

public void setGlobalNetworkId(java.lang.String value)

The ID of the global network.

getDescription

public java.lang.String getDescription()

A description of the device.

Constraints: Maximum length of 256 characters.

setDescription

public void setDescription(java.lang.String value)

A description of the device.

Constraints: Maximum length of 256 characters.

getLocation

public java.lang.Object getLocation()

The site location.

setLocation

public void setLocation(IResolvable value)

The site location.

setLocation

public void setLocation(CfnDevice.LocationProperty value)

The site location.

getModel

public java.lang.String getModel()

The model of the device.

Constraints: Maximum length of 128 characters.

setModel

public void setModel(java.lang.String value)

The model of the device.

Constraints: Maximum length of 128 characters.

getSerialNumber

public java.lang.String getSerialNumber()

The serial number of the device.

Constraints: Maximum length of 128 characters.

setSerialNumber

public void setSerialNumber(java.lang.String value)

The serial number of the device.

Constraints: Maximum length of 128 characters.

getSiteId

public java.lang.String getSiteId()

The site ID.

setSiteId

public void setSiteId(java.lang.String value)

The site ID.

getType

public java.lang.String getType()

The device type.

setType

public void setType(java.lang.String value)

The device type.

getVendor

public java.lang.String getVendor()

The vendor of the device.

Constraints: Maximum length of 128 characters.

setVendor

public void setVendor(java.lang.String value)

The vendor of the device.

Constraints: Maximum length of 128 characters.