Class: AWSCDK::Sagemaker::CfnSpace::ResourceSpecProperty

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

Overview

Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn , pass None as the value.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_type: nil, lifecycle_config_arn: nil, sage_maker_image_arn: nil, sage_maker_image_version_arn: nil, training_plan_arn: nil) ⇒ ResourceSpecProperty

Returns a new instance of ResourceSpecProperty.

Parameters:

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

    The instance type that the image version runs on.

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

    The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

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

    The ARN of the SageMaker AI image that the image version belongs to.

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

    The ARN of the image version created on the instance.

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

    The Amazon Resource Name (ARN) of the training plan to use for the ResourceSpec.



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'sagemaker/cfn_space.rb', line 1013

def initialize(instance_type: nil, lifecycle_config_arn: nil, sage_maker_image_arn: nil, sage_maker_image_version_arn: nil, training_plan_arn: nil)
  @instance_type = instance_type
  Jsii::Type.check_type(@instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType") unless @instance_type.nil?
  @lifecycle_config_arn = lifecycle_config_arn
  Jsii::Type.check_type(@lifecycle_config_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lifecycleConfigArn") unless @lifecycle_config_arn.nil?
  @sage_maker_image_arn = sage_maker_image_arn
  Jsii::Type.check_type(@sage_maker_image_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sageMakerImageArn") unless @sage_maker_image_arn.nil?
  @sage_maker_image_version_arn = sage_maker_image_version_arn
  Jsii::Type.check_type(@sage_maker_image_version_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sageMakerImageVersionArn") unless @sage_maker_image_version_arn.nil?
  @training_plan_arn = training_plan_arn
  Jsii::Type.check_type(@training_plan_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trainingPlanArn") unless @training_plan_arn.nil?
end

Instance Attribute Details

#instance_type ⇒ String? (readonly)

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

Returns:

  • (String, nil)

See Also:



1034
1035
1036
 
# File 'sagemaker/cfn_space.rb', line 1034

def instance_type
  @instance_type
end

#lifecycle_config_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

Returns:

  • (String, nil)

See Also:



1039
1040
1041
 
# File 'sagemaker/cfn_space.rb', line 1039

def lifecycle_config_arn
  @lifecycle_config_arn
end

#sage_maker_image_arn ⇒ String? (readonly)

The ARN of the SageMaker AI image that the image version belongs to.

Returns:

  • (String, nil)

See Also:



1044
1045
1046
 
# File 'sagemaker/cfn_space.rb', line 1044

def sage_maker_image_arn
  @sage_maker_image_arn
end

#sage_maker_image_version_arn ⇒ String? (readonly)

The ARN of the image version created on the instance.

To clear the value set for SageMakerImageVersionArn , pass None as the value.

Returns:

  • (String, nil)

See Also:



1051
1052
1053
 
# File 'sagemaker/cfn_space.rb', line 1051

def sage_maker_image_version_arn
  @sage_maker_image_version_arn
end

#training_plan_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the training plan to use for the ResourceSpec.

Returns:

  • (String, nil)

See Also:



1056
1057
1058
 
# File 'sagemaker/cfn_space.rb', line 1056

def training_plan_arn
  @training_plan_arn
end

Class Method Details

.jsii_properties ⇒ Object 



1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'sagemaker/cfn_space.rb', line 1058

def self.jsii_properties
  {
    :instance_type => "instanceType",
    :lifecycle_config_arn => "lifecycleConfigArn",
    :sage_maker_image_arn => "sageMakerImageArn",
    :sage_maker_image_version_arn => "sageMakerImageVersionArn",
    :training_plan_arn => "trainingPlanArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'sagemaker/cfn_space.rb', line 1068

def to_jsii
  result = {}
  result.merge!({
    "instanceType" => @instance_type,
    "lifecycleConfigArn" => @lifecycle_config_arn,
    "sageMakerImageArn" => @sage_maker_image_arn,
    "sageMakerImageVersionArn" => @sage_maker_image_version_arn,
    "trainingPlanArn" => @training_plan_arn,
  })
  result.compact
end