software.amazon.awscdk.services.sagemaker

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.sagemaker.CfnDevice

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:56.674Z")
public class CfnDevice
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::Device`.

The AWS::SageMaker::Device resource is an Amazon SageMaker resource type that allows you to register your Devices against an existing SageMaker Edge Manager DeviceFleet. Each device must be listed individually in the CFN specification.

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.sagemaker.*;
 CfnDevice cfnDevice = CfnDevice.Builder.create(this, "MyCfnDevice")
         .deviceFleetName("deviceFleetName")
         // the properties below are optional
         .device(DeviceProperty.builder()
                 .deviceName("deviceName")
                 // the properties below are optional
                 .description("description")
                 .iotThingName("iotThingName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDevice.Builder A fluent builder for CfnDevice.
static interface	CfnDevice.DeviceProperty Information of a particular device.

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::SageMaker::Device`.
protected	CfnDevice(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDevice(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDevice() Edge device you want to create.
java.lang.String	getDeviceFleetName() The name of the fleet the device belongs to.
TagManager	getTags() An array of key-value pairs that contain metadata to help you categorize and organize your devices.
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	setDevice(CfnDevice.DeviceProperty value) Edge device you want to create.
void	setDevice(IResolvable value) Edge device you want to create.
void	setDeviceFleetName(java.lang.String value) The name of the fleet the device belongs to.

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::SageMaker::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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs that contain metadata to help you categorize and organize your devices.

Each tag consists of a key and a value, both of which you define.

getDeviceFleetName

public java.lang.String getDeviceFleetName()

The name of the fleet the device belongs to.

setDeviceFleetName

public void setDeviceFleetName(java.lang.String value)

The name of the fleet the device belongs to.

getDevice

public java.lang.Object getDevice()

Edge device you want to create.

setDevice

public void setDevice(IResolvable value)

Edge device you want to create.

setDevice

public void setDevice(CfnDevice.DeviceProperty value)

Edge device you want to create.