Package software.amazon.awscdk.services.sagemaker

Interface CfnModel.S3DataSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModel.S3DataSourceProperty.Jsii$Proxy

Enclosing class:

CfnModel

@Stability(Stable)
public static interface CfnModel.S3DataSourceProperty
extends software.amazon.jsii.JsiiSerializable

Describes the S3 data source.

Your input bucket must be in the same AWS region as your training 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.*;
 S3DataSourceProperty s3DataSourceProperty = S3DataSourceProperty.builder()
         .compressionType("compressionType")
         .s3DataType("s3DataType")
         .s3Uri("s3Uri")
         // the properties below are optional
         .hubAccessConfig(HubAccessConfigProperty.builder()
                 .hubContentArn("hubContentArn")
                 .build())
         .modelAccessConfig(ModelAccessConfigProperty.builder()
                 .acceptEula(false)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModel.S3DataSourceProperty.Builder	builder()
String	getCompressionType()
default Object	getHubAccessConfig()	The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model.
default Object	getModelAccessConfig()	Returns union: either IResolvable or CfnModel.ModelAccessConfigProperty
String	getS3DataType()	If you choose S3Prefix , S3Uri identifies a key name prefix.
String	getS3Uri()	Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCompressionType

@Stability(Stable)
@NotNull
String getCompressionType()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-compressiontype

getS3DataType

@Stability(Stable)
@NotNull
String getS3DataType()

If you choose S3Prefix , S3Uri identifies a key name prefix.

SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile , S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe .

If you choose Converse , S3Uri identifies an Amazon S3 location that contains data formatted according to Converse format. This format structures conversational messages with specific roles and content types used for training and fine-tuning foundational models.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-s3datatype

getS3Uri

@Stability(Stable)
@NotNull
String getS3Uri()

Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest.

For example:

• A key name prefix might look like this: s3://bucketname/exampleprefix/
• A manifest might look like this: s3://bucketname/example.manifest

A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri . Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

The following code example shows a valid manifest format:

[ {"prefix": "s3://customer_bucket/some/prefix/"},

"relative/path/to/custdata-1",

"relative/path/custdata-2",

...

"relative/path/custdata-N"

]

This JSON is equivalent to the following S3Uri list:

s3://customer_bucket/some/prefix/relative/path/to/custdata-1

s3://customer_bucket/some/prefix/relative/path/custdata-2

...

s3://customer_bucket/some/prefix/relative/path/custdata-N

The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

Your input bucket must be located in same AWS region as your training job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-s3uri

getHubAccessConfig

@Stability(Stable)
@Nullable
default Object getHubAccessConfig()

The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model.

Returns union: either IResolvable or CfnModel.HubAccessConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-hubaccessconfig

getModelAccessConfig

@Stability(Stable)
@Nullable
default Object getModelAccessConfig()

Returns union: either IResolvable or CfnModel.ModelAccessConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-s3datasource.html#cfn-sagemaker-model-s3datasource-modelaccessconfig

builder

@Stability(Stable)
static CfnModel.S3DataSourceProperty.Builder builder()

Returns:

a CfnModel.S3DataSourceProperty.Builder of CfnModel.S3DataSourceProperty