class CfnAlgorithmPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.SageMaker.CfnAlgorithmPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awssagemaker#CfnAlgorithmPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnAlgorithmPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_sagemaker.CfnAlgorithmPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_sagemaker » CfnAlgorithmPropsMixin

Implements IMixin

Extends Mixin

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnAlgorithmPropsMixin = new sagemaker.CfnAlgorithmPropsMixin({
  algorithmDescription: 'algorithmDescription',
  algorithmName: 'algorithmName',
  certifyForMarketplace: false,
  inferenceSpecification: {
    containers: [{
      containerHostname: 'containerHostname',
      environment: {
        environmentKey: 'environment',
      },
      framework: 'framework',
      frameworkVersion: 'frameworkVersion',
      image: 'image',
      imageDigest: 'imageDigest',
      isCheckpoint: false,
      modelInput: {
        dataInputConfig: 'dataInputConfig',
      },
      nearestModelName: 'nearestModelName',
    }],
    supportedContentTypes: ['supportedContentTypes'],
    supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
    supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
    supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  trainingSpecification: {
    metricDefinitions: [{
      name: 'name',
      regex: 'regex',
    }],
    supportedHyperParameters: [{
      defaultValue: 'defaultValue',
      description: 'description',
      isRequired: false,
      isTunable: false,
      name: 'name',
      range: {
        categoricalParameterRangeSpecification: {
          values: ['values'],
        },
        continuousParameterRangeSpecification: {
          maxValue: 'maxValue',
          minValue: 'minValue',
        },
        integerParameterRangeSpecification: {
          maxValue: 'maxValue',
          minValue: 'minValue',
        },
      },
      type: 'type',
    }],
    supportedTrainingInstanceTypes: ['supportedTrainingInstanceTypes'],
    supportedTuningJobObjectiveMetrics: [{
      metricName: 'metricName',
      type: 'type',
    }],
    supportsDistributedTraining: false,
    trainingChannels: [{
      description: 'description',
      isRequired: false,
      name: 'name',
      supportedCompressionTypes: ['supportedCompressionTypes'],
      supportedContentTypes: ['supportedContentTypes'],
      supportedInputModes: ['supportedInputModes'],
    }],
    trainingImage: 'trainingImage',
    trainingImageDigest: 'trainingImageDigest',
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnAlgorithmPropsMixin(props: CfnAlgorithmMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAlgorithmMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnAlgorithmMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAlgorithmMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.