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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.059Z")
 @Stability(value=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();
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDevice(software.constructs.Construct scope, 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
String	getAttrDeviceArn() The ARN of the device.
String	getAttrDeviceId() The ID of the device.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the device.
String	getGlobalNetworkId() The ID of the global network.
Object	getLocation() The site location.
String	getModel() The model of the device.
String	getSerialNumber() The serial number of the device.
String	getSiteId() The site ID.
TagManager	getTags() The tags for the device.
String	getType() The device type.
String	getVendor() The vendor of the device.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the device.
void	setGlobalNetworkId(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(String value) The model of the device.
void	setSerialNumber(String value) The serial number of the device.
void	setSiteId(String value) The site ID.
void	setType(String value) The device type.
void	setVendor(String value) The vendor of the device.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnDevice(@NotNull
                                          software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrDeviceArn()

The ARN of the device.

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

getAttrDeviceId

@Stability(value=Stable)
 @NotNull
public String getAttrDeviceId()

The ID of the device.

For example, device-07f6fd08867abc123 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the device.

getGlobalNetworkId

@Stability(value=Stable)
 @NotNull
public String getGlobalNetworkId()

The ID of the global network.

setGlobalNetworkId

@Stability(value=Stable)
public void setGlobalNetworkId(@NotNull
                                                        String value)

The ID of the global network.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the device.

Constraints: Maximum length of 256 characters.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the device.

Constraints: Maximum length of 256 characters.

getLocation

@Stability(value=Stable)
 @Nullable
public Object getLocation()

The site location.

setLocation

@Stability(value=Stable)
public void setLocation(@Nullable
                                                 CfnDevice.LocationProperty value)

The site location.

setLocation

@Stability(value=Stable)
public void setLocation(@Nullable
                                                 IResolvable value)

The site location.

getModel

@Stability(value=Stable)
 @Nullable
public String getModel()

The model of the device.

Constraints: Maximum length of 128 characters.

setModel

@Stability(value=Stable)
public void setModel(@Nullable
                                              String value)

The model of the device.

Constraints: Maximum length of 128 characters.

getSerialNumber

@Stability(value=Stable)
 @Nullable
public String getSerialNumber()

The serial number of the device.

Constraints: Maximum length of 128 characters.

setSerialNumber

@Stability(value=Stable)
public void setSerialNumber(@Nullable
                                                     String value)

The serial number of the device.

Constraints: Maximum length of 128 characters.

getSiteId

@Stability(value=Stable)
 @Nullable
public String getSiteId()

The site ID.

setSiteId

@Stability(value=Stable)
public void setSiteId(@Nullable
                                               String value)

The site ID.

getType

@Stability(value=Stable)
 @Nullable
public String getType()

The device type.

setType

@Stability(value=Stable)
public void setType(@Nullable
                                             String value)

The device type.

getVendor

@Stability(value=Stable)
 @Nullable
public String getVendor()

The vendor of the device.

Constraints: Maximum length of 128 characters.

setVendor

@Stability(value=Stable)
public void setVendor(@Nullable
                                               String value)

The vendor of the device.

Constraints: Maximum length of 128 characters.