software.amazon.awscdk.services.stepfunctions.tasks

Class ResourceConfig.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.ResourceConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ResourceConfig>

Enclosing interface:

ResourceConfig

@Stability(value=Stable)
public static final class ResourceConfig.Builder
extends Object
implements software.amazon.jsii.Builder<ResourceConfig>

A builder for ResourceConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ResourceConfig	build() Builds the configured instance.
ResourceConfig.Builder	instanceCount(Number instanceCount) Sets the value of ResourceConfig.getInstanceCount()
ResourceConfig.Builder	instanceType(InstanceType instanceType) Sets the value of ResourceConfig.getInstanceType()
ResourceConfig.Builder	volumeEncryptionKey(IKey volumeEncryptionKey) Sets the value of ResourceConfig.getVolumeEncryptionKey()
ResourceConfig.Builder	volumeSize(Size volumeSize) Sets the value of ResourceConfig.getVolumeSize()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

instanceCount

@Stability(value=Stable)
public ResourceConfig.Builder instanceCount(Number instanceCount)

Sets the value of ResourceConfig.getInstanceCount()

Parameters:

instanceCount - The number of ML compute instances to use. This parameter is required.

Returns:

this

instanceType

@Stability(value=Stable)
public ResourceConfig.Builder instanceType(InstanceType instanceType)

Sets the value of ResourceConfig.getInstanceType()

Parameters:

instanceType - ML compute instance type. This parameter is required. To provide an instance type from the task input, supply an instance type in the following way where the value in the task input is an EC2 instance type prepended with "ml.":

                     new InstanceType(JsonPath.stringAt("$.path.to.instanceType"));
                     

Returns:

this

volumeSize

@Stability(value=Stable)
public ResourceConfig.Builder volumeSize(Size volumeSize)

Sets the value of ResourceConfig.getVolumeSize()

Parameters:

volumeSize - Size of the ML storage volume that you want to provision. This parameter is required.

Returns:

this

volumeEncryptionKey

@Stability(value=Stable)
public ResourceConfig.Builder volumeEncryptionKey(IKey volumeEncryptionKey)

Sets the value of ResourceConfig.getVolumeEncryptionKey()

Parameters:

volumeEncryptionKey - 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.

Returns:

this

build

@Stability(value=Stable)
public ResourceConfig build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ResourceConfig>

Returns:

a new instance of ResourceConfig

Throws:

NullPointerException - if any required attribute was not provided