mlflow_tracking_servers

Creates, updates, deletes or gets a mlflow_tracking_server resource or lists mlflow_tracking_servers in a region

Overview

Name	mlflow_tracking_servers
Type	Resource
Description	Resource Type definition for AWS::SageMaker::MlflowTrackingServer
Id	aws.sagemaker.mlflow_tracking_servers

Fields

Name	Datatype	Description
tracking_server_name	string	The name of the MLFlow Tracking Server.
tracking_server_arn	string	The Amazon Resource Name (ARN) of the MLFlow Tracking Server.
tracking_server_size	string	The size of the MLFlow Tracking Server.
mlflow_version	string	The MLFlow Version used on the MLFlow Tracking Server.
role_arn	string	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on behalf of the customer.
artifact_store_uri	string	The Amazon S3 URI for MLFlow Tracking Server artifacts.
automatic_model_registration	boolean	A flag to enable Automatic SageMaker Model Registration.
weekly_maintenance_window_start	string	The start of the time window for maintenance of the MLFlow Tracking Server in UTC time.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::SageMaker::MlflowTrackingServer.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TrackingServerName, ArtifactStoreUri, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all mlflow_tracking_servers in a region.

SELECT
region,
tracking_server_name,
tracking_server_arn,
tracking_server_size,
mlflow_version,
role_arn,
artifact_store_uri,
automatic_model_registration,
weekly_maintenance_window_start,
tags
FROM aws.sagemaker.mlflow_tracking_servers
WHERE region = 'us-east-1';

Gets all properties from an individual mlflow_tracking_server.

SELECT
region,
tracking_server_name,
tracking_server_arn,
tracking_server_size,
mlflow_version,
role_arn,
artifact_store_uri,
automatic_model_registration,
weekly_maintenance_window_start,
tags
FROM aws.sagemaker.mlflow_tracking_servers
WHERE region = 'us-east-1' AND data__Identifier = '<TrackingServerName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.mlflow_tracking_servers (
 TrackingServerName,
 RoleArn,
 ArtifactStoreUri,
 region
)
SELECT 
'{{ TrackingServerName }}',
 '{{ RoleArn }}',
 '{{ ArtifactStoreUri }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.mlflow_tracking_servers (
 TrackingServerName,
 TrackingServerSize,
 MlflowVersion,
 RoleArn,
 ArtifactStoreUri,
 AutomaticModelRegistration,
 WeeklyMaintenanceWindowStart,
 Tags,
 region
)
SELECT 
 '{{ TrackingServerName }}',
 '{{ TrackingServerSize }}',
 '{{ MlflowVersion }}',
 '{{ RoleArn }}',
 '{{ ArtifactStoreUri }}',
 '{{ AutomaticModelRegistration }}',
 '{{ WeeklyMaintenanceWindowStart }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: mlflow_tracking_server
    props:
      - name: TrackingServerName
        value: '{{ TrackingServerName }}'
      - name: TrackingServerSize
        value: '{{ TrackingServerSize }}'
      - name: MlflowVersion
        value: '{{ MlflowVersion }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: ArtifactStoreUri
        value: '{{ ArtifactStoreUri }}'
      - name: AutomaticModelRegistration
        value: '{{ AutomaticModelRegistration }}'
      - name: WeeklyMaintenanceWindowStart
        value: '{{ WeeklyMaintenanceWindowStart }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

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

Permissions

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

Create

sagemaker:CreateMlflowTrackingServer,
sagemaker:DescribeMlflowTrackingServer,
sagemaker:AddTags,
sagemaker:ListTags,
iam:PassRole

Read

sagemaker:DescribeMlflowTrackingServer,
sagemaker:ListTags

Update

sagemaker:UpdateMlflowTrackingServer,
sagemaker:DescribeMlflowTrackingServer,
sagemaker:ListTags,
sagemaker:AddTags,
sagemaker:DeleteTags,
iam:PassRole

Delete

sagemaker:DeleteMlflowTrackingServer,
sagemaker:DescribeMlflowTrackingServer

List

sagemaker:ListMlflowTrackingServers