Package software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.S3DataSourceProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnModelPackage.S3DataSourceProperty.Jsii$Proxy
Enclosing class:
CfnModelPackage
@Stability(Stable) public static interface CfnModelPackage.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()
         .s3DataType("s3DataType")
         .s3Uri("s3Uri")
         .build();

  • Method Details

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

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

    • builder

      @Stability(Stable) static CfnModelPackage.S3DataSourceProperty.Builder builder()
      Returns:
      a CfnModelPackage.S3DataSourceProperty.Builder of CfnModelPackage.S3DataSourceProperty