Package software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.TransformResourcesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelPackage.TransformResourcesProperty.Jsii$Proxy

Enclosing class:

CfnModelPackage

@Stability(Stable)
public static interface CfnModelPackage.TransformResourcesProperty
extends software.amazon.jsii.JsiiSerializable

Describes the resources, including ML instance types and ML instance count, to use for transform job.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 TransformResourcesProperty transformResourcesProperty = TransformResourcesProperty.builder()
         .instanceCount(123)
         .instanceType("instanceType")
         // the properties below are optional
         .volumeKmsKeyId("volumeKmsKeyId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelPackage.TransformResourcesProperty.Builder	A builder for CfnModelPackage.TransformResourcesProperty
static final class	CfnModelPackage.TransformResourcesProperty.Jsii$Proxy	An implementation for CfnModelPackage.TransformResourcesProperty

Method Summary

Modifier and Type	Method	Description
static CfnModelPackage.TransformResourcesProperty.Builder	builder()
Number	getInstanceCount()	The number of ML compute instances to use in the transform job.
String	getInstanceType()	The ML compute instance type for the transform job.
default String	getVolumeKmsKeyId()	The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceCount

@Stability(Stable)
@NotNull
Number getInstanceCount()

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

The default value is 1 , and the maximum is 100 . For distributed transform jobs, specify a value greater than 1 .

See Also:

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

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

The ML compute instance type for the transform job.

If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

See Also:

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

getVolumeKmsKeyId

@Stability(Stable)
@Nullable
default String getVolumeKmsKeyId()

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

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes .

For more information about local instance storage encryption, see SSD Instance Store Volumes .

The VolumeKmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

See Also:

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

builder

@Stability(Stable)
static CfnModelPackage.TransformResourcesProperty.Builder builder()

Returns:

a CfnModelPackage.TransformResourcesProperty.Builder of CfnModelPackage.TransformResourcesProperty