Class: AWSCDK::Sagemaker::CfnUserProfile::CustomImageProperty

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

Overview

A custom SageMaker AI image.

For more information, see Bring your own SageMaker AI image .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_image_config_name:, image_name:, image_version_number: nil) ⇒ CustomImageProperty

Returns a new instance of CustomImageProperty.

Parameters:

  • app_image_config_name (String) —

    The name of the AppImageConfig.

  • image_name (String) —

    The name of the CustomImage.

  • image_version_number (Numeric, nil) (defaults to: nil) —

    The version number of the CustomImage.



789
790
791
792
793
794
795
796
 
# File 'sagemaker/cfn_user_profile.rb', line 789

def initialize(app_image_config_name:, image_name:, image_version_number: nil)
  @app_image_config_name = app_image_config_name
  Jsii::Type.check_type(@app_image_config_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appImageConfigName")
  @image_name = image_name
  Jsii::Type.check_type(@image_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageName")
  @image_version_number = image_version_number
  Jsii::Type.check_type(@image_version_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "imageVersionNumber") unless @image_version_number.nil?
end

Instance Attribute Details

#app_image_config_name ⇒ String (readonly)

The name of the AppImageConfig.

Returns:

  • (String)

See Also:



802
803
804
 
# File 'sagemaker/cfn_user_profile.rb', line 802

def app_image_config_name
  @app_image_config_name
end

#image_name ⇒ String (readonly)

The name of the CustomImage.

Must be unique to your account.

Returns:

  • (String)

See Also:



809
810
811
 
# File 'sagemaker/cfn_user_profile.rb', line 809

def image_name
  @image_name
end

#image_version_number ⇒ Numeric? (readonly)

The version number of the CustomImage.

Returns:

  • (Numeric, nil)

See Also:



814
815
816
 
# File 'sagemaker/cfn_user_profile.rb', line 814

def image_version_number
  @image_version_number
end

Class Method Details

.jsii_properties ⇒ Object 



816
817
818
819
820
821
822
 
# File 'sagemaker/cfn_user_profile.rb', line 816

def self.jsii_properties
  {
    :app_image_config_name => "appImageConfigName",
    :image_name => "imageName",
    :image_version_number => "imageVersionNumber",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



824
825
826
827
828
829
830
831
832
 
# File 'sagemaker/cfn_user_profile.rb', line 824

def to_jsii
  result = {}
  result.merge!({
    "appImageConfigName" => @app_image_config_name,
    "imageName" => @image_name,
    "imageVersionNumber" => @image_version_number,
  })
  result.compact
end