Class: AWSCDK::Sagemaker::CfnApp::ResourceSpecProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Sagemaker::CfnApp::ResourceSpecProperty

Defined in:

sagemaker/cfn_app.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html

Instance Attribute Summary

• #instance_type ⇒ String^? readonly

  The instance type that the image version runs on.

• #lifecycle_config_arn ⇒ String^? readonly

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

• #sage_maker_image_arn ⇒ String^? readonly

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

• #sage_maker_image_version_arn ⇒ String^? readonly

  The ARN of the image version created on the instance.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

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

  A new instance of ResourceSpecProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(instance_type: nil, lifecycle_config_arn: nil, sage_maker_image_arn: nil, sage_maker_image_version_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.

# File 'sagemaker/cfn_app.rb', line 613

def initialize(instance_type: nil, lifecycle_config_arn: nil, sage_maker_image_arn: nil, sage_maker_image_version_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?
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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-instancetype

# File 'sagemaker/cfn_app.rb', line 632

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-lifecycleconfigarn

# File 'sagemaker/cfn_app.rb', line 637

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimagearn

# File 'sagemaker/cfn_app.rb', line 642

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html#cfn-sagemaker-app-resourcespec-sagemakerimageversionarn

# File 'sagemaker/cfn_app.rb', line 649

def sage_maker_image_version_arn
  @sage_maker_image_version_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sagemaker/cfn_app.rb', line 651

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

Instance Method Details

#to_jsii ⇒ Object

# File 'sagemaker/cfn_app.rb', line 660

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