Package software.amazon.awscdk.services.sagemaker

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.sagemaker.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:35.124Z") @Stability(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();

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

    • getCfnProperties

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

    • getTags

      @Stability(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(Stable) @NotNull public String getDeviceFleetName()
      The name of the fleet the device belongs to.

    • setDeviceFleetName

      @Stability(Stable) public void setDeviceFleetName(@NotNull String value)
      The name of the fleet the device belongs to.

    • getDevice

      @Stability(Stable) @Nullable public Object getDevice()
      Edge device you want to create.

    • setDevice

      @Stability(Stable) public void setDevice(@Nullable IResolvable value)
      Edge device you want to create.

    • setDevice

      @Stability(Stable) public void setDevice(@Nullable CfnDevice.DeviceProperty value)
      Edge device you want to create.