Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.SourceAlgorithmProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCard.SourceAlgorithmProperty.Jsii$Proxy

Enclosing class:

CfnModelCard

@Stability(Stable)
public static interface CfnModelCard.SourceAlgorithmProperty
extends software.amazon.jsii.JsiiSerializable

Specifies an algorithm that was used to create the model package.

The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

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.*;
 SourceAlgorithmProperty sourceAlgorithmProperty = SourceAlgorithmProperty.builder()
         .algorithmName("algorithmName")
         // the properties below are optional
         .modelDataUrl("modelDataUrl")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCard.SourceAlgorithmProperty.Builder	builder()
String	getAlgorithmName()	The name of an algorithm that was used to create the model package.
default String	getModelDataUrl()	The Amazon S3 path where the model artifacts, which result from model training, are stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlgorithmName

@Stability(Stable)
@NotNull
String getAlgorithmName()

The name of an algorithm that was used to create the model package.

The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html#cfn-sagemaker-modelcard-sourcealgorithm-algorithmname

getModelDataUrl

@Stability(Stable)
@Nullable
default String getModelDataUrl()

The Amazon S3 path where the model artifacts, which result from model training, are stored.

This path must point to a single gzip compressed tar archive ( .tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same AWS region as the algorithm.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html#cfn-sagemaker-modelcard-sourcealgorithm-modeldataurl

builder

@Stability(Stable)
static CfnModelCard.SourceAlgorithmProperty.Builder builder()

Returns:

a CfnModelCard.SourceAlgorithmProperty.Builder of CfnModelCard.SourceAlgorithmProperty