Class: AWSCDK::Sagemaker::CfnMlflowAppProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_mlflow_app_props.rb

Overview

Properties for defining a CfnMlflowApp.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(artifact_store_uri:, name:, role_arn:, model_registration_mode: nil, tags: nil, weekly_maintenance_window_start: nil) ⇒ CfnMlflowAppProps

Returns a new instance of CfnMlflowAppProps.

Parameters:

  • artifact_store_uri (String) —

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

  • name (String) —

    The name of the MLflow App.

  • role_arn (String) —

    The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.

  • model_registration_mode (String, nil) (defaults to: nil) —

    Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to associate with the MLflow App.

  • weekly_maintenance_window_start (String, nil) (defaults to: nil) —

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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 15

def initialize(artifact_store_uri:, name:, role_arn:, model_registration_mode: nil, tags: nil, weekly_maintenance_window_start: nil)
  @artifact_store_uri = artifact_store_uri
  Jsii::Type.check_type(@artifact_store_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "artifactStoreUri")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @model_registration_mode = model_registration_mode
  Jsii::Type.check_type(@model_registration_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelRegistrationMode") unless @model_registration_mode.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @weekly_maintenance_window_start = weekly_maintenance_window_start
  Jsii::Type.check_type(@weekly_maintenance_window_start, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "weeklyMaintenanceWindowStart") unless @weekly_maintenance_window_start.nil?
end

Instance Attribute Details

#artifact_store_uri ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



34
35
36
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 34

def artifact_store_uri
  @artifact_store_uri
end

#model_registration_mode ⇒ String? (readonly)

Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 49

def model_registration_mode
  @model_registration_mode
end

#name ⇒ String (readonly)

The name of the MLflow App.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 39

def name
  @name
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 44

def role_arn
  @role_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to associate with the MLflow App.

Returns:

See Also:



54
55
56
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 54

def tags
  @tags
end

#weekly_maintenance_window_start ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 61

def weekly_maintenance_window_start
  @weekly_maintenance_window_start
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 63

def self.jsii_properties
  {
    :artifact_store_uri => "artifactStoreUri",
    :name => "name",
    :role_arn => "roleArn",
    :model_registration_mode => "modelRegistrationMode",
    :tags => "tags",
    :weekly_maintenance_window_start => "weeklyMaintenanceWindowStart",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'sagemaker/cfn_mlflow_app_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "artifactStoreUri" => @artifact_store_uri,
    "name" => @name,
    "roleArn" => @role_arn,
    "modelRegistrationMode" => @model_registration_mode,
    "tags" => @tags,
    "weeklyMaintenanceWindowStart" => @weekly_maintenance_window_start,
  })
  result.compact
end