AWS::SageMaker::MlflowTrackingServer - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::MlflowTrackingServer

Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::MlflowTrackingServer",
  "Properties" : {
      "ArtifactStoreUri" : String,
      "AutomaticModelRegistration" : Boolean,
      "MlflowVersion" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ],
      "TrackingServerName" : String,
      "TrackingServerSize" : String,
      "WeeklyMaintenanceWindowStart" : String
    }
}

YAML

Type: AWS::SageMaker::MlflowTrackingServer
Properties:
  ArtifactStoreUri: String
  AutomaticModelRegistration: Boolean
  MlflowVersion: String
  RoleArn: String
  Tags: 
    - Tag
  TrackingServerName: String
  TrackingServerSize: String
  WeeklyMaintenanceWindowStart: String

Properties

ArtifactStoreUri

The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.

Required: Yes

Type: String

Pattern: ^s3:\/\/([^\/]+)\/?(.*)$

Minimum: 1

Maximum: 2048

Update requires: No interruption

AutomaticModelRegistration

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.

Required: No

Type: Boolean

Update requires: No interruption

MlflowVersion

The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.

Required: No

Type: String

Pattern: ^\d+(\.\d+)+$

Minimum: 1

Maximum: 32

Update requires: Some interruptions

RoleArn

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.

Required: Yes

Type: String

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role\/?[a-zA-Z_0-9+=,.@\-_\/]+$

Minimum: 20

Maximum: 2048

Update requires: Some interruptions

Tags

Tags consisting of key-value pairs used to manage metadata for the tracking server.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 50

Update requires: No interruption

TrackingServerName

A unique string identifying the tracking server name. This string is part of the tracking server ARN.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}$

Minimum: 1

Maximum: 256

Update requires: Replacement

TrackingServerSize

The size of the tracking server you want to create. You can choose between "Small", "Medium", and "Large". The default MLflow Tracking Server configuration size is "Small". You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.

We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.

Required: No

Type: String

Allowed values: Small | Medium | Large

Update requires: No interruption

WeeklyMaintenanceWindowStart

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

Required: No

Type: String

Pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):([0-5]\d)$

Maximum: 9

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

TrackingServerArn

The ARN of the tracking server.