# CfnImageVersionProps

Properties for defining a `CfnImageVersion`.

Extends: CfnImageVersionProps
Used as props by: CfnImageVersion

- Source: Generated code
- Type last changed: v2.163.0 · 22 Oct 2024

## Example

```ts
// 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-lib';
const cfnImageVersionProps: sagemaker.CfnImageVersionProps = {
  baseImage: 'baseImage',
  imageName: 'imageName',

  // the properties below are optional
  alias: 'alias',
  aliases: ['aliases'],
  horovod: false,
  jobType: 'jobType',
  mlFramework: 'mlFramework',
  processor: 'processor',
  programmingLang: 'programmingLang',
  releaseNotes: 'releaseNotes',
  vendorGuidance: 'vendorGuidance',
};
```

## Properties

- `alias`: string — The alias of the image version.

- `aliases`: string[] — List of aliases for the image version.

- `baseImage`: string (required) — The container image that the SageMaker image version is based on.

- `horovod`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates Horovod compatibility.

- `imageName`: string (required) — The name of the parent image.

  *Length Constraints* : Minimum length of 1. Maximum length of 63.

  *Pattern* : `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$`

- `jobType`: string — Indicates SageMaker job type compatibility.

- `mlFramework`: string — The machine learning framework vended in the image version.

- `processor`: string — Indicates CPU or GPU compatibility.

- `programmingLang`: string — The supported programming language and its version.

- `releaseNotes`: string — The maintainer description of the image version.

- `vendorGuidance`: string — The availability of the image version specified by the maintainer.