Package software.amazon.awscdk.services.sagemaker

Class CfnModelPackage.S3DataSourceProperty.Builder

java.lang.Object
software.amazon.awscdk.services.sagemaker.CfnModelPackage.S3DataSourceProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnModelPackage.S3DataSourceProperty>
Enclosing interface:
CfnModelPackage.S3DataSourceProperty
@Stability(Stable) public static final class CfnModelPackage.S3DataSourceProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnModelPackage.S3DataSourceProperty>
A builder for CfnModelPackage.S3DataSourceProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • s3DataType

      @Stability(Stable) public CfnModelPackage.S3DataSourceProperty.Builder s3DataType(String s3DataType)
      Sets the value of CfnModelPackage.S3DataSourceProperty.getS3DataType()
      Parameters:
      s3DataType - If you choose S3Prefix , S3Uri identifies a key name prefix. This parameter is required. 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 .

      Returns:
      this

    • s3Uri

      @Stability(Stable) public CfnModelPackage.S3DataSourceProperty.Builder s3Uri(String s3Uri)
      Sets the value of CfnModelPackage.S3DataSourceProperty.getS3Uri()
      Parameters:
      s3Uri - Depending on the value specified for the S3DataType , identifies either a key name prefix or a manifest. This parameter is required. 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 CfnModelPackage.S3DataSourceProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnModelPackage.S3DataSourceProperty>
      Returns:
      a new instance of CfnModelPackage.S3DataSourceProperty
      Throws:
      NullPointerException - if any required attribute was not provided