CfnDeviceFleetProps

class aws_cdk.aws_sagemaker.CfnDeviceFleetProps(*, device_fleet_name, output_config, role_arn, description=None, tags=None)

Bases: object

Properties for defining a CfnDeviceFleet.

Parameters
  • device_fleet_name (str) – Name of the device fleet.

  • output_config (Union[IResolvable, EdgeOutputConfigProperty, Dict[str, Any]]) – The output configuration for storing sample data collected by the fleet.

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

  • description (Optional[str]) – A description of the fleet.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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"
    )]
)

Attributes

description

A description of the fleet.

Link

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

Return type

Optional[str]

device_fleet_name

Name of the device fleet.

Link

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

Return type

str

output_config

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

Link

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

Return type

Union[IResolvable, EdgeOutputConfigProperty]

role_arn

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

Link

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

Return type

str

tags

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.

Link

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

Return type

Optional[List[CfnTag]]