Class CfnDeviceFleet

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.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDeviceFleet

Implements

IInspectable

IDeviceFleetRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeviceFleet : CfnResource, IInspectable, IDeviceFleetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDeviceFleet Inherits CfnResource Implements IInspectable, IDeviceFleetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var cfnDeviceFleet = new CfnDeviceFleet(this, "MyCfnDeviceFleet", new CfnDeviceFleetProps {
                 DeviceFleetName = "deviceFleetName",
                 OutputConfig = new EdgeOutputConfigProperty {
                     S3OutputLocation = "s3OutputLocation",

                     // the properties below are optional
                     KmsKeyId = "kmsKeyId"
                 },
                 RoleArn = "roleArn",

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDeviceFleet(Construct, string, ICfnDeviceFleetProps)

Create a new AWS::SageMaker::DeviceFleet.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	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.
Description	A description of the fleet.
DeviceFleetName	Name of the device fleet.
DeviceFleetRef	A reference to a DeviceFleet resource.
OutputConfig	The output configuration for storing sample data collected by the fleet.
RoleArn	The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs that contain metadata to help you categorize and organize your device fleets.

Methods

ArnForDeviceFleet(IDeviceFleetRef)	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.
FromDeviceFleetName(Construct, string, string)	Creates a new IDeviceFleetRef from a deviceFleetName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDeviceFleet(object)	Checks whether the given object is a CfnDeviceFleet.
RenderProperties(IDictionary<string, object>)	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.

Constructors

CfnDeviceFleet(Construct, string, ICfnDeviceFleetProps)

Create a new AWS::SageMaker::DeviceFleet.

public CfnDeviceFleet(Construct scope, string id, ICfnDeviceFleetProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDeviceFleetProps

Resource properties.

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

CfnProperties

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.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Description

A description of the fleet.

public virtual string? Description { get; set; }

Property Value

string

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

DeviceFleetName

Name of the device fleet.

public virtual string DeviceFleetName { get; set; }

Property Value

string

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

DeviceFleetRef

A reference to a DeviceFleet resource.

public virtual IDeviceFleetReference DeviceFleetRef { get; }

Property Value

IDeviceFleetReference

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

OutputConfig

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

public virtual object OutputConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeviceFleet.IEdgeOutputConfigProperty

RoleArn

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

public virtual string RoleArn { get; set; }

Property Value

string

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

TagsRaw

An array of key-value pairs that contain metadata to help you categorize and organize your device fleets.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Methods

ArnForDeviceFleet(IDeviceFleetRef)

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.

public static string ArnForDeviceFleet(IDeviceFleetRef resource)

Parameters

resource IDeviceFleetRef

Returns

string

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var cfnDeviceFleet = new CfnDeviceFleet(this, "MyCfnDeviceFleet", new CfnDeviceFleetProps {
                 DeviceFleetName = "deviceFleetName",
                 OutputConfig = new EdgeOutputConfigProperty {
                     S3OutputLocation = "s3OutputLocation",

                     // the properties below are optional
                     KmsKeyId = "kmsKeyId"
                 },
                 RoleArn = "roleArn",

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromDeviceFleetName(Construct, string, string)

Creates a new IDeviceFleetRef from a deviceFleetName.

public static IDeviceFleetRef FromDeviceFleetName(Construct scope, string id, string deviceFleetName)

Parameters

scope Construct

id string

deviceFleetName string

Returns

IDeviceFleetRef

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

IsCfnDeviceFleet(object)

Checks whether the given object is a CfnDeviceFleet.

public static bool IsCfnDeviceFleet(object x)

Parameters

x object

Returns

bool

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

You must register your devices against the DeviceFleet separately.

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

CloudformationResource: AWS::SageMaker::DeviceFleet

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDeviceFleetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable