software.amazon.awscdk.services.stepfunctions.tasks

Interface ResourceConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ResourceConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-08-11T10:33:08.027Z")
 @Stability(value=Experimental)
public interface ResourceConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ResourceConfig.Builder	builder()
Number	getInstanceCount() (experimental) The number of ML compute instances to use.
InstanceType	getInstanceType() (experimental) ML compute instance type.
default IKey	getVolumeEncryptionKey() (experimental) KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Size	getVolumeSize() (experimental) Size of the ML storage volume that you want to provision.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceCount

@Stability(value=Experimental)
 @NotNull
Number getInstanceCount()

(experimental) The number of ML compute instances to use.

Default: 1 instance.

getInstanceType

@Stability(value=Experimental)
 @NotNull
InstanceType getInstanceType()

(experimental) ML compute instance type.

Default: ec2.InstanceType(ec2.InstanceClass.M4, ec2.InstanceType.XLARGE)

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 To;provide;an;instance;type from thetask;input , write
 `new ec2.InstanceType(sfn.JsonPath.stringAt('$.path.to.instanceType'))` , where;the;value in the;task;input;is;an;EC2;instance;type prepended with"ml.".get();

See Also:

https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceConfig.html#sagemaker-Type-ResourceConfig-InstanceType

getVolumeSize

@Stability(value=Experimental)
 @NotNull
Size getVolumeSize()

(experimental) Size of the ML storage volume that you want to provision.

Default: 10 GB EBS volume.

getVolumeEncryptionKey

@Stability(value=Experimental)
 @Nullable
default IKey getVolumeEncryptionKey()

(experimental) KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Default: - Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account

builder

@Stability(value=Experimental)
static ResourceConfig.Builder builder()

Returns:

a ResourceConfig.Builder of ResourceConfig