Package software.amazon.awscdk.services.sagemaker

Class CfnDeviceFleet

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.CfnDeviceFleet
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.126Z") @Stability(Stable) public class CfnDeviceFleet extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::DeviceFleet.

The AWS::SageMaker::DeviceFleet resource is an Amazon SageMaker resource type that allows you to create a DeviceFleet that manages your SageMaker Edge Manager Devices. You must register your devices against the DeviceFleet separately.

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.*;
 CfnDeviceFleet cfnDeviceFleet = CfnDeviceFleet.Builder.create(this, "MyCfnDeviceFleet")
         .deviceFleetName("deviceFleetName")
         .outputConfig(EdgeOutputConfigProperty.builder()
                 .s3OutputLocation("s3OutputLocation")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .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

    • CfnDeviceFleet

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

    • CfnDeviceFleet

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

    • CfnDeviceFleet

      @Stability(Stable) public CfnDeviceFleet(@NotNull Construct scope, @NotNull String id, @NotNull CfnDeviceFleetProps props)
      Create a new AWS::SageMaker::DeviceFleet.

      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 device fleets.

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

    • getDeviceFleetName

      @Stability(Stable) @NotNull public String getDeviceFleetName()
      Name of the device fleet.

    • setDeviceFleetName

      @Stability(Stable) public void setDeviceFleetName(@NotNull String value)
      Name of the device fleet.

    • getOutputConfig

      @Stability(Stable) @NotNull public Object getOutputConfig()
      The output configuration for storing sample data collected by the fleet.

    • setOutputConfig

      @Stability(Stable) public void setOutputConfig(@NotNull IResolvable value)
      The output configuration for storing sample data collected by the fleet.

    • setOutputConfig

      @Stability(Stable) public void setOutputConfig(@NotNull CfnDeviceFleet.EdgeOutputConfigProperty value)
      The output configuration for storing sample data collected by the fleet.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the fleet.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the fleet.