Interface CfnAlgorithmProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAlgorithmProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
date="2026-07-24T11:46:53.985Z")
@Stability(Stable)
public interface CfnAlgorithmProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnAlgorithm.
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.*;
CfnAlgorithmProps cfnAlgorithmProps = CfnAlgorithmProps.builder()
.algorithmName("algorithmName")
.trainingSpecification(TrainingSpecificationProperty.builder()
.supportedTrainingInstanceTypes(List.of("supportedTrainingInstanceTypes"))
.trainingChannels(List.of(ChannelSpecificationProperty.builder()
.name("name")
.supportedContentTypes(List.of("supportedContentTypes"))
.supportedInputModes(List.of("supportedInputModes"))
// the properties below are optional
.description("description")
.isRequired(false)
.supportedCompressionTypes(List.of("supportedCompressionTypes"))
.build()))
.trainingImage("trainingImage")
// the properties below are optional
.metricDefinitions(List.of(MetricDefinitionProperty.builder()
.name("name")
.regex("regex")
.build()))
.supportedHyperParameters(List.of(HyperParameterSpecificationProperty.builder()
.name("name")
.type("type")
// the properties below are optional
.defaultValue("defaultValue")
.description("description")
.isRequired(false)
.isTunable(false)
.range(ParameterRangeProperty.builder()
.categoricalParameterRangeSpecification(CategoricalParameterRangeSpecificationProperty.builder()
.values(List.of("values"))
.build())
.continuousParameterRangeSpecification(ContinuousParameterRangeSpecificationProperty.builder()
.maxValue("maxValue")
.minValue("minValue")
.build())
.integerParameterRangeSpecification(IntegerParameterRangeSpecificationProperty.builder()
.maxValue("maxValue")
.minValue("minValue")
.build())
.build())
.build()))
.supportedTuningJobObjectiveMetrics(List.of(HyperParameterTuningJobObjectiveProperty.builder()
.metricName("metricName")
.type("type")
.build()))
.supportsDistributedTraining(false)
.trainingImageDigest("trainingImageDigest")
.build())
// the properties below are optional
.algorithmDescription("algorithmDescription")
.certifyForMarketplace(false)
.inferenceSpecification(InferenceSpecificationProperty.builder()
.containers(List.of(ModelPackageContainerDefinitionProperty.builder()
.image("image")
// the properties below are optional
.containerHostname("containerHostname")
.environment(Map.of(
"environmentKey", "environment"))
.framework("framework")
.frameworkVersion("frameworkVersion")
.imageDigest("imageDigest")
.isCheckpoint(false)
.modelInput(ModelInputProperty.builder()
.dataInputConfig("dataInputConfig")
.build())
.nearestModelName("nearestModelName")
.build()))
// the properties below are optional
.supportedContentTypes(List.of("supportedContentTypes"))
.supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
.supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
.supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAlgorithmPropsstatic final classAn implementation forCfnAlgorithmProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAlgorithmProps.Builderbuilder()default StringA description of the algorithm.The name of the algorithm.default ObjectWhether to certify the algorithm so that it can be listed in AWS Marketplace.default ObjectReturns union: eitherIResolvableorCfnAlgorithm.InferenceSpecificationPropertygetTags()An array of key-value pairs to apply to this resource.Returns union: eitherIResolvableorCfnAlgorithm.TrainingSpecificationPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAlgorithmName
The name of the algorithm.- See Also:
-
getTrainingSpecification
Returns union: eitherIResolvableorCfnAlgorithm.TrainingSpecificationProperty- See Also:
-
getAlgorithmDescription
A description of the algorithm.- See Also:
-
getCertifyForMarketplace
Whether to certify the algorithm so that it can be listed in AWS Marketplace.Returns union: either
BooleanorIResolvable- See Also:
-
getInferenceSpecification
Returns union: eitherIResolvableorCfnAlgorithm.InferenceSpecificationProperty- See Also:
-
getTags
An array of key-value pairs to apply to this resource.- See Also:
-
builder
- Returns:
- a
CfnAlgorithmProps.BuilderofCfnAlgorithmProps
-