software.amazon.awscdk.services.sagemaker

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.sagemaker.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.864Z")
 @Stability(value=Stable)
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 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::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 Map<String,Object>	getCfnProperties()
Object	getDevice() Edge device you want to create.
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 Map<String,Object>	renderProperties(Map<String,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(String value) The name of the fleet the device belongs to.

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

The name of the fleet the device belongs to.

setDeviceFleetName

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

The name of the fleet the device belongs to.

getDevice

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

Edge device you want to create.

setDevice

@Stability(value=Stable)
public void setDevice(@Nullable
                                               CfnDevice.DeviceProperty value)

Edge device you want to create.

setDevice

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

Edge device you want to create.