Package software.amazon.awscdk.services.sagemaker

Class CfnModelPackage.S3ModelDataSourceProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sagemaker.CfnModelPackage.S3ModelDataSourceProperty.Jsii$Proxy

All Implemented Interfaces:

CfnModelPackage.S3ModelDataSourceProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnModelPackage.S3ModelDataSourceProperty

@Stability(Stable)
@Internal
public static final class CfnModelPackage.S3ModelDataSourceProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnModelPackage.S3ModelDataSourceProperty

An implementation for CfnModelPackage.S3ModelDataSourceProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sagemaker.CfnModelPackage.S3ModelDataSourceProperty

CfnModelPackage.S3ModelDataSourceProperty.Builder, CfnModelPackage.S3ModelDataSourceProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnModelPackage.S3ModelDataSourceProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnModelPackage.S3ModelDataSourceProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getCompressionType()	Specifies how the ML model data is prepared.
final Object	getModelAccessConfig()	Specifies the access configuration file for the ML model.
final String	getS3DataType()	Specifies the type of ML model data to deploy.
final String	getS3Uri()	Specifies the S3 path of ML model data to deploy.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnModelPackage.S3ModelDataSourceProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnModelPackage.S3ModelDataSourceProperty.Builder.

Method Details

getCompressionType

public final String getCompressionType()

Description copied from interface: CfnModelPackage.S3ModelDataSourceProperty

Specifies how the ML model data is prepared.

If you choose Gzip and choose S3Object as the value of S3DataType , S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment.

If you choose None and chooose S3Object as the value of S3DataType , S3Uri identifies an object that represents an uncompressed ML model to deploy.

If you choose None and choose S3Prefix as the value of S3DataType , S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy.

If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:

• If you choose S3Object as the value of S3DataType , then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.
• If you choose S3Prefix as the value of S3DataType , then for each S3 object under the key name pefix referenced by S3Uri , SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model ) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.
• Do not use any of the following as file names or directory names:
• An empty or blank string
• A string which contains null bytes
• A string longer than 255 bytes
• A single dot ( . )
• A double dot ( .. )
• Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType , then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).
• Do not organize the model artifacts in S3 console using folders . When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.

Specified by:

getCompressionType in interface CfnModelPackage.S3ModelDataSourceProperty

See Also:

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

getS3DataType

public final String getS3DataType()

Description copied from interface: CfnModelPackage.S3ModelDataSourceProperty

Specifies the type of ML model data to deploy.

If you choose S3Prefix , S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/).

If you choose S3Object , S3Uri identifies an object that is the ML model data to deploy.

Specified by:

getS3DataType in interface CfnModelPackage.S3ModelDataSourceProperty

See Also:

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

getS3Uri

public final String getS3Uri()

Description copied from interface: CfnModelPackage.S3ModelDataSourceProperty

Specifies the S3 path of ML model data to deploy.

Specified by:

getS3Uri in interface CfnModelPackage.S3ModelDataSourceProperty

See Also:

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

getModelAccessConfig

public final Object getModelAccessConfig()

Description copied from interface: CfnModelPackage.S3ModelDataSourceProperty

Specifies the access configuration file for the ML model.

You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig . You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

Specified by:

getModelAccessConfig in interface CfnModelPackage.S3ModelDataSourceProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object