Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnModelPropsMixin.S3DataSourceProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnModelPropsMixin.S3DataSourceProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnModelPropsMixin.S3DataSourceProperty>

Enclosing interface:

CfnModelPropsMixin.S3DataSourceProperty

@Stability(Stable)
public static final class CfnModelPropsMixin.S3DataSourceProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnModelPropsMixin.S3DataSourceProperty>

A builder for CfnModelPropsMixin.S3DataSourceProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnModelPropsMixin.S3DataSourceProperty	build()	Builds the configured instance.
CfnModelPropsMixin.S3DataSourceProperty.Builder	compressionType(String compressionType)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getCompressionType()
CfnModelPropsMixin.S3DataSourceProperty.Builder	hubAccessConfig(CfnModelPropsMixin.HubAccessConfigProperty hubAccessConfig)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getHubAccessConfig()
CfnModelPropsMixin.S3DataSourceProperty.Builder	hubAccessConfig(IResolvable hubAccessConfig)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getHubAccessConfig()
CfnModelPropsMixin.S3DataSourceProperty.Builder	modelAccessConfig(CfnModelPropsMixin.ModelAccessConfigProperty modelAccessConfig)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getModelAccessConfig()
CfnModelPropsMixin.S3DataSourceProperty.Builder	modelAccessConfig(IResolvable modelAccessConfig)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getModelAccessConfig()
CfnModelPropsMixin.S3DataSourceProperty.Builder	s3DataType(String s3DataType)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getS3DataType()
CfnModelPropsMixin.S3DataSourceProperty.Builder	s3Uri(String s3Uri)	Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getS3Uri()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

compressionType

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder compressionType(String compressionType)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getCompressionType()

Parameters:

compressionType - the value to be set.

Returns:

this

hubAccessConfig

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder hubAccessConfig(IResolvable hubAccessConfig)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getHubAccessConfig()

Parameters:

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

Returns:

this

hubAccessConfig

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder hubAccessConfig(CfnModelPropsMixin.HubAccessConfigProperty hubAccessConfig)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getHubAccessConfig()

Parameters:

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

Returns:

this

modelAccessConfig

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder modelAccessConfig(IResolvable modelAccessConfig)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getModelAccessConfig()

Parameters:

modelAccessConfig - the value to be set.

Returns:

this

modelAccessConfig

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder modelAccessConfig(CfnModelPropsMixin.ModelAccessConfigProperty modelAccessConfig)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getModelAccessConfig()

Parameters:

modelAccessConfig - the value to be set.

Returns:

this

s3DataType

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder s3DataType(String s3DataType)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getS3DataType()

Parameters:

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

Returns:

this

s3Uri

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty.Builder s3Uri(String s3Uri)

Sets the value of CfnModelPropsMixin.S3DataSourceProperty.getS3Uri()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnModelPropsMixin.S3DataSourceProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnModelPropsMixin.S3DataSourceProperty>

Returns:

a new instance of CfnModelPropsMixin.S3DataSourceProperty

Throws:

NullPointerException - if any required attribute was not provided