class CfnModelPackagePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins.CfnModelPackagePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssagemaker/mixins#CfnModelPackagePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnModelPackagePropsMixin
Python	aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnModelPackagePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_sagemaker » mixins » CfnModelPackagePropsMixin

Implements IMixin

Extends Mixin

A container for your trained model that can be deployed for SageMaker inference.

This can include inference code, artifacts, and metadata. The model package type can be one of the following.

• Versioned model: A part of a model package group in Model Registry.
• Unversioned model: Not part of a model package group and used in AWS Marketplace.

For more information, see CreateModelPackage .

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

Example

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

declare const modelInput: any;
const cfnModelPackagePropsMixin = new sagemaker_mixins.CfnModelPackagePropsMixin({
  additionalInferenceSpecifications: [{
    containers: [{
      containerHostname: 'containerHostname',
      environment: {
        environmentKey: 'environment',
      },
      framework: 'framework',
      frameworkVersion: 'frameworkVersion',
      image: 'image',
      imageDigest: 'imageDigest',
      modelDataSource: {
        s3DataSource: {
          compressionType: 'compressionType',
          modelAccessConfig: {
            acceptEula: false,
          },
          s3DataType: 's3DataType',
          s3Uri: 's3Uri',
        },
      },
      modelDataUrl: 'modelDataUrl',
      modelInput: modelInput,
      nearestModelName: 'nearestModelName',
    }],
    description: 'description',
    name: 'name',
    supportedContentTypes: ['supportedContentTypes'],
    supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
    supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
    supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
  }],
  additionalInferenceSpecificationsToAdd: [{
    containers: [{
      containerHostname: 'containerHostname',
      environment: {
        environmentKey: 'environment',
      },
      framework: 'framework',
      frameworkVersion: 'frameworkVersion',
      image: 'image',
      imageDigest: 'imageDigest',
      modelDataSource: {
        s3DataSource: {
          compressionType: 'compressionType',
          modelAccessConfig: {
            acceptEula: false,
          },
          s3DataType: 's3DataType',
          s3Uri: 's3Uri',
        },
      },
      modelDataUrl: 'modelDataUrl',
      modelInput: modelInput,
      nearestModelName: 'nearestModelName',
    }],
    description: 'description',
    name: 'name',
    supportedContentTypes: ['supportedContentTypes'],
    supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
    supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
    supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
  }],
  approvalDescription: 'approvalDescription',
  certifyForMarketplace: false,
  clientToken: 'clientToken',
  customerMetadataProperties: {
    customerMetadataPropertiesKey: 'customerMetadataProperties',
  },
  domain: 'domain',
  driftCheckBaselines: {
    bias: {
      configFile: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      postTrainingConstraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      preTrainingConstraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
    explainability: {
      configFile: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      constraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
    modelDataQuality: {
      constraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      statistics: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
    modelQuality: {
      constraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      statistics: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
  },
  inferenceSpecification: {
    containers: [{
      containerHostname: 'containerHostname',
      environment: {
        environmentKey: 'environment',
      },
      framework: 'framework',
      frameworkVersion: 'frameworkVersion',
      image: 'image',
      imageDigest: 'imageDigest',
      modelDataSource: {
        s3DataSource: {
          compressionType: 'compressionType',
          modelAccessConfig: {
            acceptEula: false,
          },
          s3DataType: 's3DataType',
          s3Uri: 's3Uri',
        },
      },
      modelDataUrl: 'modelDataUrl',
      modelInput: modelInput,
      nearestModelName: 'nearestModelName',
    }],
    supportedContentTypes: ['supportedContentTypes'],
    supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
    supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
    supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
  },
  lastModifiedTime: 'lastModifiedTime',
  metadataProperties: {
    commitId: 'commitId',
    generatedBy: 'generatedBy',
    projectId: 'projectId',
    repository: 'repository',
  },
  modelApprovalStatus: 'modelApprovalStatus',
  modelCard: {
    modelCardContent: 'modelCardContent',
    modelCardStatus: 'modelCardStatus',
  },
  modelMetrics: {
    bias: {
      postTrainingReport: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      preTrainingReport: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      report: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
    explainability: {
      report: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
    modelDataQuality: {
      constraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      statistics: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
    modelQuality: {
      constraints: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
      statistics: {
        contentDigest: 'contentDigest',
        contentType: 'contentType',
        s3Uri: 's3Uri',
      },
    },
  },
  modelPackageDescription: 'modelPackageDescription',
  modelPackageGroupName: 'modelPackageGroupName',
  modelPackageName: 'modelPackageName',
  modelPackageStatusDetails: {
    validationStatuses: [{
      failureReason: 'failureReason',
      name: 'name',
      status: 'status',
    }],
  },
  modelPackageVersion: 123,
  samplePayloadUrl: 'samplePayloadUrl',
  securityConfig: {
    kmsKeyId: 'kmsKeyId',
  },
  skipModelValidation: 'skipModelValidation',
  sourceAlgorithmSpecification: {
    sourceAlgorithms: [{
      algorithmName: 'algorithmName',
      modelDataUrl: 'modelDataUrl',
    }],
  },
  sourceUri: 'sourceUri',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  task: 'task',
  validationSpecification: {
    validationProfiles: [{
      profileName: 'profileName',
      transformJobDefinition: {
        batchStrategy: 'batchStrategy',
        environment: {
          environmentKey: 'environment',
        },
        maxConcurrentTransforms: 123,
        maxPayloadInMb: 123,
        transformInput: {
          compressionType: 'compressionType',
          contentType: 'contentType',
          dataSource: {
            s3DataSource: {
              s3DataType: 's3DataType',
              s3Uri: 's3Uri',
            },
          },
          splitType: 'splitType',
        },
        transformOutput: {
          accept: 'accept',
          assembleWith: 'assembleWith',
          kmsKeyId: 'kmsKeyId',
          s3OutputPath: 's3OutputPath',
        },
        transformResources: {
          instanceCount: 123,
          instanceType: 'instanceType',
          volumeKmsKeyId: 'volumeKmsKeyId',
        },
      },
    }],
    validationRole: 'validationRole',
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnModelPackagePropsMixin(props: CfnModelPackageMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

Name	Type	Description
props	CfnModelPackageMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnModelPackageMixinProps

---

strategy

Type: PropertyMergeStrategy

---

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): IConstruct

Parameters

• construct IConstruct

Returns

• 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.