Package software.amazon.awscdk.services.sagemaker

Interface CfnDeviceFleetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeviceFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:13.351Z")
@Stability(Stable)
public interface CfnDeviceFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeviceFleet.

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.*;
 CfnDeviceFleetProps cfnDeviceFleetProps = CfnDeviceFleetProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeviceFleetProps.Builder	A builder for CfnDeviceFleetProps
static final class	CfnDeviceFleetProps.Jsii$Proxy	An implementation for CfnDeviceFleetProps

Method Summary

Modifier and Type	Method	Description
static CfnDeviceFleetProps.Builder	builder()
default String	getDescription()	A description of the fleet.
String	getDeviceFleetName()	Name of the device fleet.
Object	getOutputConfig()	The output configuration for storing sample data collected by the fleet.
String	getRoleArn()	The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
default List<CfnTag>	getTags()	An array of key-value pairs that contain metadata to help you categorize and organize your device fleets.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeviceFleetName

@Stability(Stable)
@NotNull
String getDeviceFleetName()

Name of the device fleet.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-devicefleetname

getOutputConfig

@Stability(Stable)
@NotNull
Object getOutputConfig()

The output configuration for storing sample data collected by the fleet.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-outputconfig

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-rolearn

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the fleet.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-description

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-devicefleet.html#cfn-sagemaker-devicefleet-tags

builder

@Stability(Stable)
static CfnDeviceFleetProps.Builder builder()

Returns:

a CfnDeviceFleetProps.Builder of CfnDeviceFleetProps