Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnAlgorithmPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnAlgorithmPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:48.375Z")
@Stability(Stable)
public class CfnAlgorithmPropsMixin
extends Mixin
implements software.constructs.IMixin

Resource Type definition for AWS::SageMaker::Algorithm.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAlgorithmPropsMixin cfnAlgorithmPropsMixin = CfnAlgorithmPropsMixin.Builder.create(CfnAlgorithmMixinProps.builder()
         .algorithmDescription("algorithmDescription")
         .algorithmName("algorithmName")
         .certifyForMarketplace(false)
         .inferenceSpecification(InferenceSpecificationProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .image("image")
                         .imageDigest("imageDigest")
                         .isCheckpoint(false)
                         .modelInput(ModelInputProperty.builder()
                                 .dataInputConfig("dataInputConfig")
                                 .build())
                         .nearestModelName("nearestModelName")
                         .build()))
                 .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()))
         .trainingSpecification(TrainingSpecificationProperty.builder()
                 .metricDefinitions(List.of(MetricDefinitionProperty.builder()
                         .name("name")
                         .regex("regex")
                         .build()))
                 .supportedHyperParameters(List.of(HyperParameterSpecificationProperty.builder()
                         .defaultValue("defaultValue")
                         .description("description")
                         .isRequired(false)
                         .isTunable(false)
                         .name("name")
                         .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())
                         .type("type")
                         .build()))
                 .supportedTrainingInstanceTypes(List.of("supportedTrainingInstanceTypes"))
                 .supportedTuningJobObjectiveMetrics(List.of(HyperParameterTuningJobObjectiveProperty.builder()
                         .metricName("metricName")
                         .type("type")
                         .build()))
                 .supportsDistributedTraining(false)
                 .trainingChannels(List.of(ChannelSpecificationProperty.builder()
                         .description("description")
                         .isRequired(false)
                         .name("name")
                         .supportedCompressionTypes(List.of("supportedCompressionTypes"))
                         .supportedContentTypes(List.of("supportedContentTypes"))
                         .supportedInputModes(List.of("supportedInputModes"))
                         .build()))
                 .trainingImage("trainingImage")
                 .trainingImageDigest("trainingImageDigest")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnAlgorithmPropsMixin.Builder	A fluent builder for CfnAlgorithmPropsMixin.
static interface	CfnAlgorithmPropsMixin.CategoricalParameterRangeSpecificationProperty	Example:
static interface	CfnAlgorithmPropsMixin.ChannelSpecificationProperty	Example:
static interface	CfnAlgorithmPropsMixin.ContinuousParameterRangeSpecificationProperty	Example:
static interface	CfnAlgorithmPropsMixin.HyperParameterSpecificationProperty	Example:
static interface	CfnAlgorithmPropsMixin.HyperParameterTuningJobObjectiveProperty	Example:
static interface	CfnAlgorithmPropsMixin.InferenceSpecificationProperty	Example:
static interface	CfnAlgorithmPropsMixin.IntegerParameterRangeSpecificationProperty	Example:
static interface	CfnAlgorithmPropsMixin.MetricDefinitionProperty	Example:
static interface	CfnAlgorithmPropsMixin.ModelInputProperty	Example:
static interface	CfnAlgorithmPropsMixin.ModelPackageContainerDefinitionProperty	Example:
static interface	CfnAlgorithmPropsMixin.ParameterRangeProperty	Example:
static interface	CfnAlgorithmPropsMixin.TrainingSpecificationProperty	Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAlgorithmPropsMixin(CfnAlgorithmMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::Algorithm.
	CfnAlgorithmPropsMixin(CfnAlgorithmMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::Algorithm.
protected	CfnAlgorithmPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAlgorithmPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAlgorithmMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAlgorithmPropsMixin

protected CfnAlgorithmPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnAlgorithmPropsMixin

protected CfnAlgorithmPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAlgorithmPropsMixin

@Stability(Stable)
public CfnAlgorithmPropsMixin(@NotNull
 CfnAlgorithmMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::Algorithm.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAlgorithmPropsMixin

@Stability(Stable)
public CfnAlgorithmPropsMixin(@NotNull
 CfnAlgorithmMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::Algorithm.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAlgorithmMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()