# CfnDeviceFleetProps

Properties for defining a `CfnDeviceFleet`.

Used as props by: [CfnDeviceFleet](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDeviceFleet.html)

- Source: Generated at build time
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnDeviceFleetProps: sagemaker.CfnDeviceFleetProps = {
  deviceFleetName: 'deviceFleetName',
  outputConfig: {
    s3OutputLocation: 's3OutputLocation',

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  },
  roleArn: 'roleArn',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

Python:

```python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_device_fleet_props = sagemaker.CfnDeviceFleetProps(
    device_fleet_name="deviceFleetName",
    output_config=sagemaker.CfnDeviceFleet.EdgeOutputConfigProperty(
        s3_output_location="s3OutputLocation",

        # the properties below are optional
        kms_key_id="kmsKeyId"
    ),
    role_arn="roleArn",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
```

Java:

```java
// 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnDeviceFleetProps = 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"
    } }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnDeviceFleetProps := &CfnDeviceFleetProps{
	DeviceFleetName: jsii.String("deviceFleetName"),
	OutputConfig: &EdgeOutputConfigProperty{
		S3OutputLocation: jsii.String("s3OutputLocation"),

		// the properties below are optional
		KmsKeyId: jsii.String("kmsKeyId"),
	},
	RoleArn: jsii.String("roleArn"),

	// the properties below are optional
	Description: jsii.String("description"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}
```

## Properties

- `description`: string — A description of the fleet.

- `deviceFleetName`: string (required) — Name of the device fleet.

- `outputConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeviceFleet.EdgeOutputConfigProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnDeviceFleet.EdgeOutputConfigProperty.html) (required) — The output configuration for storing sample data collected by the fleet.

- `roleArn`: string | [IRoleRef](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.IRoleRef.html) (required) — The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

- `tags`: [CfnTag](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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.
