software.amazon.awscdk.services.sagemaker

Class CfnDeviceFleet

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

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.865Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDeviceFleet.Builder A fluent builder for CfnDeviceFleet.
static interface	CfnDeviceFleet.EdgeOutputConfigProperty The output configuration for storing sample data collected by the fleet.

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
	CfnDeviceFleet(software.constructs.Construct scope, String id, CfnDeviceFleetProps props) Create a new `AWS::SageMaker::DeviceFleet`.
protected	CfnDeviceFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeviceFleet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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).
TagManager	getTags() An array of key-value pairs that contain metadata to help you categorize and organize your device fleets.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the fleet.
void	setDeviceFleetName(String value) Name of the device fleet.
void	setOutputConfig(CfnDeviceFleet.EdgeOutputConfigProperty value) The output configuration for storing sample data collected by the fleet.
void	setOutputConfig(IResolvable value) The output configuration for storing sample data collected by the fleet.
void	setRoleArn(String value) The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

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

CfnDeviceFleet

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

CfnDeviceFleet

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

CfnDeviceFleet

@Stability(value=Stable)
public CfnDeviceFleet(@NotNull
                                               software.constructs.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 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 device fleets.

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

getDeviceFleetName

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

Name of the device fleet.

setDeviceFleetName

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

Name of the device fleet.

getOutputConfig

@Stability(value=Stable)
 @NotNull
public Object getOutputConfig()

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

setOutputConfig

@Stability(value=Stable)
public void setOutputConfig(@NotNull
                                                     CfnDeviceFleet.EdgeOutputConfigProperty value)

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

setOutputConfig

@Stability(value=Stable)
public void setOutputConfig(@NotNull
                                                     IResolvable value)

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

getRoleArn

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

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

setRoleArn

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

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the fleet.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the fleet.