Package software.amazon.awscdk.services.stepfunctions.tasks

Interface OutputDataConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OutputDataConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.123Z")
@Stability(Stable)
public interface OutputDataConfig
extends software.amazon.jsii.JsiiSerializable

Configures the S3 bucket where SageMaker will save the result of model training.

Example:

 SageMakerCreateTrainingJob.Builder.create(this, "TrainSagemaker")
         .trainingJobName(JsonPath.stringAt("$.JobName"))
         .algorithmSpecification(AlgorithmSpecification.builder()
                 .algorithmName("BlazingText")
                 .trainingInputMode(InputMode.FILE)
                 .build())
         .inputDataConfig(List.of(Channel.builder()
                 .channelName("train")
                 .dataSource(DataSource.builder()
                         .s3DataSource(S3DataSource.builder()
                                 .s3DataType(S3DataType.S3_PREFIX)
                                 .s3Location(S3Location.fromJsonExpression("$.S3Bucket"))
                                 .build())
                         .build())
                 .build()))
         .outputDataConfig(OutputDataConfig.builder()
                 .s3OutputLocation(S3Location.fromBucket(Bucket.fromBucketName(this, "Bucket", "mybucket"), "myoutputpath"))
                 .build())
         .resourceConfig(ResourceConfig.builder()
                 .instanceCount(1)
                 .instanceType(new InstanceType(JsonPath.stringAt("$.InstanceType")))
                 .volumeSize(Size.gibibytes(50))
                 .build()) // optional: default is 1 instance of EC2 `M4.XLarge` with `10GB` volume
         .stoppingCondition(StoppingCondition.builder()
                 .maxRuntime(Duration.hours(2))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OutputDataConfig.Builder	builder()
default IKey	getEncryptionKey()	Optional KMS encryption key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
S3Location	getS3OutputLocation()	Identifies the S3 path where you want Amazon SageMaker to store the model artifacts.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3OutputLocation

@Stability(Stable)
@NotNull
S3Location getS3OutputLocation()

Identifies the S3 path where you want Amazon SageMaker to store the model artifacts.

getEncryptionKey

@Stability(Stable)
@Nullable
default IKey getEncryptionKey()

Optional KMS encryption key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

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

builder

@Stability(Stable)
static OutputDataConfig.Builder builder()

Returns:

a OutputDataConfig.Builder of OutputDataConfig