Class: AWSCDK::Sagemaker::CfnImageVersionProps

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

Overview

Properties for defining a CfnImageVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_image:, image_name:, _alias: nil, aliases: nil, horovod: nil, job_type: nil, ml_framework: nil, processor: nil, programming_lang: nil, release_notes: nil, vendor_guidance: nil) ⇒ CfnImageVersionProps

Returns a new instance of CfnImageVersionProps.

Parameters:

  • base_image (String) —

    The container image that the SageMaker image version is based on.

  • image_name (String) —

    The name of the parent image.

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

    The alias of the image version.

  • aliases (Array<String>, nil) (defaults to: nil) —

    List of aliases for the image version.

  • horovod (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates Horovod compatibility.

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

    Indicates SageMaker job type compatibility.

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

    The machine learning framework vended in the image version.

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

    Indicates CPU or GPU compatibility.

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

    The supported programming language and its version.

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

    The maintainer description of the image version.

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

    The availability of the image version specified by the maintainer.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'sagemaker/cfn_image_version_props.rb', line 20

def initialize(base_image:, image_name:, _alias: nil, aliases: nil, horovod: nil, job_type: nil, ml_framework: nil, processor: nil, programming_lang: nil, release_notes: nil, vendor_guidance: nil)
  @base_image = base_image
  Jsii::Type.check_type(@base_image, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "baseImage")
  @image_name = image_name
  Jsii::Type.check_type(@image_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageName")
  @_alias = _alias
  Jsii::Type.check_type(@_alias, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alias") unless @_alias.nil?
  @aliases = aliases
  Jsii::Type.check_type(@aliases, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "aliases") unless @aliases.nil?
  @horovod = horovod
  Jsii::Type.check_type(@horovod, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "horovod") unless @horovod.nil?
  @job_type = job_type
  Jsii::Type.check_type(@job_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobType") unless @job_type.nil?
  @ml_framework = ml_framework
  Jsii::Type.check_type(@ml_framework, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mlFramework") unless @ml_framework.nil?
  @processor = processor
  Jsii::Type.check_type(@processor, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "processor") unless @processor.nil?
  @programming_lang = programming_lang
  Jsii::Type.check_type(@programming_lang, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "programmingLang") unless @programming_lang.nil?
  @release_notes = release_notes
  Jsii::Type.check_type(@release_notes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "releaseNotes") unless @release_notes.nil?
  @vendor_guidance = vendor_guidance
  Jsii::Type.check_type(@vendor_guidance, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vendorGuidance") unless @vendor_guidance.nil?
end

Instance Attribute Details

#_alias ⇒ String? (readonly)

The alias of the image version.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'sagemaker/cfn_image_version_props.rb', line 63

def _alias
  @_alias
end

#aliases ⇒ Array<String>? (readonly)

List of aliases for the image version.

Returns:

  • (Array<String>, nil)

See Also:



68
69
70
 
# File 'sagemaker/cfn_image_version_props.rb', line 68

def aliases
  @aliases
end

#base_image ⇒ String (readonly)

The container image that the SageMaker image version is based on.

Returns:

  • (String)

See Also:



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

def base_image
  @base_image
end

#horovod ⇒ Boolean, ... (readonly)

Indicates Horovod compatibility.

Returns:

See Also:



73
74
75
 
# File 'sagemaker/cfn_image_version_props.rb', line 73

def horovod
  @horovod
end

#image_name ⇒ String (readonly)

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Returns:

  • (String)

See Also:



58
59
60
 
# File 'sagemaker/cfn_image_version_props.rb', line 58

def image_name
  @image_name
end

#job_type ⇒ String? (readonly)

Indicates SageMaker job type compatibility.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'sagemaker/cfn_image_version_props.rb', line 78

def job_type
  @job_type
end

#ml_framework ⇒ String? (readonly)

The machine learning framework vended in the image version.

Returns:

  • (String, nil)

See Also:



83
84
85
 
# File 'sagemaker/cfn_image_version_props.rb', line 83

def ml_framework
  @ml_framework
end

#processor ⇒ String? (readonly)

Indicates CPU or GPU compatibility.

Returns:

  • (String, nil)

See Also:



88
89
90
 
# File 'sagemaker/cfn_image_version_props.rb', line 88

def processor
  @processor
end

#programming_lang ⇒ String? (readonly)

The supported programming language and its version.

Returns:

  • (String, nil)

See Also:



93
94
95
 
# File 'sagemaker/cfn_image_version_props.rb', line 93

def programming_lang
  @programming_lang
end

#release_notes ⇒ String? (readonly)

The maintainer description of the image version.

Returns:

  • (String, nil)

See Also:



98
99
100
 
# File 'sagemaker/cfn_image_version_props.rb', line 98

def release_notes
  @release_notes
end

#vendor_guidance ⇒ String? (readonly)

The availability of the image version specified by the maintainer.

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'sagemaker/cfn_image_version_props.rb', line 103

def vendor_guidance
  @vendor_guidance
end

Class Method Details

.jsii_properties ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'sagemaker/cfn_image_version_props.rb', line 105

def self.jsii_properties
  {
    :base_image => "baseImage",
    :image_name => "imageName",
    :_alias => "alias",
    :aliases => "aliases",
    :horovod => "horovod",
    :job_type => "jobType",
    :ml_framework => "mlFramework",
    :processor => "processor",
    :programming_lang => "programmingLang",
    :release_notes => "releaseNotes",
    :vendor_guidance => "vendorGuidance",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'sagemaker/cfn_image_version_props.rb', line 121

def to_jsii
  result = {}
  result.merge!({
    "baseImage" => @base_image,
    "imageName" => @image_name,
    "alias" => @_alias,
    "aliases" => @aliases,
    "horovod" => @horovod,
    "jobType" => @job_type,
    "mlFramework" => @ml_framework,
    "processor" => @processor,
    "programmingLang" => @programming_lang,
    "releaseNotes" => @release_notes,
    "vendorGuidance" => @vendor_guidance,
  })
  result.compact
end