device_fleets

Creates, updates, deletes or gets a device_fleet resource or lists device_fleets in a region

Overview

Name	device_fleets
Type	Resource
Description	Resource schema for AWS::SageMaker::DeviceFleet
Id	aws.sagemaker.device_fleets

Fields

Name	Datatype	Description
description	string	Description for the edge device fleet
device_fleet_name	string	The name of the edge device fleet
output_config	object	S3 bucket and an ecryption key id (if available) to store outputs for the fleet
role_arn	string	Role associated with the device fleet
tags	array	Associate tags with the resource
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DeviceFleetName, OutputConfig, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual device_fleet.

SELECT
region,
description,
device_fleet_name,
output_config,
role_arn,
tags
FROM aws.sagemaker.device_fleets
WHERE region = 'us-east-1' AND data__Identifier = '<DeviceFleetName>';

INSERT example

Use the following StackQL query and manifest file to create a new device_fleet resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.device_fleets (
 DeviceFleetName,
 OutputConfig,
 RoleArn,
 region
)
SELECT 
'{{ DeviceFleetName }}',
 '{{ OutputConfig }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.device_fleets (
 Description,
 DeviceFleetName,
 OutputConfig,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ DeviceFleetName }}',
 '{{ OutputConfig }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: device_fleet
    props:
      - name: Description
        value: '{{ Description }}'
      - name: DeviceFleetName
        value: '{{ DeviceFleetName }}'
      - name: OutputConfig
        value:
          S3OutputLocation: '{{ S3OutputLocation }}'
          KmsKeyId: '{{ KmsKeyId }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.device_fleets
WHERE data__Identifier = '<DeviceFleetName>'
AND region = 'us-east-1';

Permissions

To operate on the device_fleets resource, the following permissions are required:

Create

sagemaker:CreateDeviceFleet,
iam:PassRole

Read

sagemaker:DescribeDeviceFleet

Update

sagemaker:UpdateDeviceFleet,
iam:PassRole

Delete

sagemaker:DeleteDeviceFleet