Class: AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ClusterConfigProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ClusterConfigProperty

Defined in:

sagemaker/cfn_model_explainability_job_definition.rb

Overview

The configuration for the cluster resources used to run the processing job.

See Also:

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

Instance Attribute Summary

• #instance_count ⇒ Numeric readonly

  The number of ML compute instances to use in the model monitoring job.

• #instance_type ⇒ String readonly

  The ML compute instance type for the processing job.

• #volume_kms_key_id ⇒ String^? readonly

  The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

• #volume_size_in_gb ⇒ Numeric readonly

  The size of the ML storage volume, in gigabytes, that you want to provision.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(instance_count:, instance_type:, volume_size_in_gb:, volume_kms_key_id: nil) ⇒ ClusterConfigProperty constructor

  A new instance of ClusterConfigProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(instance_count:, instance_type:, volume_size_in_gb:, volume_kms_key_id: nil) ⇒ ClusterConfigProperty

Returns a new instance of ClusterConfigProperty.

Parameters:

• instance_count (Numeric) —

  The number of ML compute instances to use in the model monitoring job.

• instance_type (String) —

  The ML compute instance type for the processing job.

• volume_size_in_gb (Numeric) —

  The size of the ML storage volume, in gigabytes, that you want to provision.

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

  The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 765

def initialize(instance_count:, instance_type:, volume_size_in_gb:, volume_kms_key_id: nil)
  @instance_count = instance_count
  Jsii::Type.check_type(@instance_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "instanceCount")
  @instance_type = instance_type
  Jsii::Type.check_type(@instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  @volume_size_in_gb = volume_size_in_gb
  Jsii::Type.check_type(@volume_size_in_gb, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "volumeSizeInGb")
  @volume_kms_key_id = volume_kms_key_id
  Jsii::Type.check_type(@volume_kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "volumeKmsKeyId") unless @volume_kms_key_id.nil?
end

Instance Attribute Details

#instance_count ⇒ Numeric (readonly)

The number of ML compute instances to use in the model monitoring job.

For distributed processing jobs, specify a value greater than 1. The default value is 1.

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-instancecount

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 782

def instance_count
  @instance_count
end

#instance_type ⇒ String (readonly)

The ML compute instance type for the processing job.

Returns:

• (String)

See Also:

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

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 787

def instance_type
  @instance_type
end

#volume_kms_key_id ⇒ String^? (readonly)

The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-volumekmskeyid

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 799

def volume_kms_key_id
  @volume_kms_key_id
end

#volume_size_in_gb ⇒ Numeric (readonly)

The size of the ML storage volume, in gigabytes, that you want to provision.

You must specify sufficient ML storage for your scenario.

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-clusterconfig.html#cfn-sagemaker-modelexplainabilityjobdefinition-clusterconfig-volumesizeingb

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 794

def volume_size_in_gb
  @volume_size_in_gb
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 801

def self.jsii_properties
  {
    :instance_count => "instanceCount",
    :instance_type => "instanceType",
    :volume_size_in_gb => "volumeSizeInGb",
    :volume_kms_key_id => "volumeKmsKeyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 810

def to_jsii
  result = {}
  result.merge!({
    "instanceCount" => @instance_count,
    "instanceType" => @instance_type,
    "volumeSizeInGb" => @volume_size_in_gb,
    "volumeKmsKeyId" => @volume_kms_key_id,
  })
  result.compact
end