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

Interface S3DataSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3DataSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.536Z")
@Stability(Stable)
public interface S3DataSource
extends software.amazon.jsii.JsiiSerializable

S3 location of the channel data.

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();
 

See Also:

• https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_S3DataSource.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3DataSource.Builder	builder()
default List<String>	getAttributeNames()	List of one or more attribute names to use that are found in a specified augmented manifest file.
default S3DataDistributionType	getS3DataDistributionType()	S3 Data Distribution Type.
default S3DataType	getS3DataType()	S3 Data Type.
S3Location	getS3Location()	S3 Uri.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3Location

@Stability(Stable)
@NotNull
S3Location getS3Location()

S3 Uri.

getAttributeNames

@Stability(Stable)
@Nullable
default List<String> getAttributeNames()

List of one or more attribute names to use that are found in a specified augmented manifest file.

Default: - No attribute names

getS3DataDistributionType

@Stability(Stable)
@Nullable
default S3DataDistributionType getS3DataDistributionType()

S3 Data Distribution Type.

Default: - None

getS3DataType

@Stability(Stable)
@Nullable
default S3DataType getS3DataType()

S3 Data Type.

Default: S3_PREFIX

builder

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

Returns:

a S3DataSource.Builder of S3DataSource