# CfnModelCardProps

Properties for defining a `CfnModelCard`.

Extends: CfnModelCardProps
Used as props by: CfnModelCard

- Source: Generated code
- Type last changed: v2.64.0 · 9 Feb 2023

## 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';

declare const value: any;
const cfnModelCardProps: sagemaker.CfnModelCardProps = {
  content: {
    additionalInformation: {
      caveatsAndRecommendations: 'caveatsAndRecommendations',
      customDetails: {
        customDetailsKey: 'customDetails',
      },
      ethicalConsiderations: 'ethicalConsiderations',
    },
    businessDetails: {
      businessProblem: 'businessProblem',
      businessStakeholders: 'businessStakeholders',
      lineOfBusiness: 'lineOfBusiness',
    },
    evaluationDetails: [{
      name: 'name',

      // the properties below are optional
      datasets: ['datasets'],
      evaluationJobArn: 'evaluationJobArn',
      evaluationObservation: 'evaluationObservation',
      metadata: {
        metadataKey: 'metadata',
      },
      metricGroups: [{
        metricData: [{
          name: 'name',
          type: 'type',
          value: value,

          // the properties below are optional
          notes: 'notes',
          xAxisName: ['xAxisName'],
          yAxisName: ['yAxisName'],
        }],
        name: 'name',
      }],
    }],
    intendedUses: {
      explanationsForRiskRating: 'explanationsForRiskRating',
      factorsAffectingModelEfficiency: 'factorsAffectingModelEfficiency',
      intendedUses: 'intendedUses',
      purposeOfModel: 'purposeOfModel',
      riskRating: 'riskRating',
    },
    modelOverview: {
      algorithmType: 'algorithmType',
      inferenceEnvironment: {
        containerImage: ['containerImage'],
      },
      modelArtifact: ['modelArtifact'],
      modelCreator: 'modelCreator',
      modelDescription: 'modelDescription',
      modelId: 'modelId',
      modelName: 'modelName',
      modelOwner: 'modelOwner',
      modelVersion: 123,
      problemType: 'problemType',
    },
    modelPackageDetails: {
      approvalDescription: 'approvalDescription',
      createdBy: {
        userProfileName: 'userProfileName',
      },
      domain: 'domain',
      inferenceSpecification: {
        containers: [{
          image: 'image',

          // the properties below are optional
          modelDataUrl: 'modelDataUrl',
          nearestModelName: 'nearestModelName',
        }],
      },
      modelApprovalStatus: 'modelApprovalStatus',
      modelPackageArn: 'modelPackageArn',
      modelPackageDescription: 'modelPackageDescription',
      modelPackageGroupName: 'modelPackageGroupName',
      modelPackageName: 'modelPackageName',
      modelPackageStatus: 'modelPackageStatus',
      modelPackageVersion: 123,
      sourceAlgorithms: [{
        algorithmName: 'algorithmName',

        // the properties below are optional
        modelDataUrl: 'modelDataUrl',
      }],
      task: 'task',
    },
    trainingDetails: {
      objectiveFunction: {
        function: {
          condition: 'condition',
          facet: 'facet',
          function: 'function',
        },
        notes: 'notes',
      },
      trainingJobDetails: {
        hyperParameters: [{
          name: 'name',
          value: 'value',
        }],
        trainingArn: 'trainingArn',
        trainingDatasets: ['trainingDatasets'],
        trainingEnvironment: {
          containerImage: ['containerImage'],
        },
        trainingMetrics: [{
          name: 'name',
          value: 123,

          // the properties below are optional
          notes: 'notes',
        }],
        userProvidedHyperParameters: [{
          name: 'name',
          value: 'value',
        }],
        userProvidedTrainingMetrics: [{
          name: 'name',
          value: 123,

          // the properties below are optional
          notes: 'notes',
        }],
      },
      trainingObservations: 'trainingObservations',
    },
  },
  modelCardName: 'modelCardName',
  modelCardStatus: 'modelCardStatus',

  // the properties below are optional
  createdBy: {
    domainId: 'domainId',
    userProfileArn: 'userProfileArn',
    userProfileName: 'userProfileName',
  },
  lastModifiedBy: {
    domainId: 'domainId',
    userProfileArn: 'userProfileArn',
    userProfileName: 'userProfileName',
  },
  securityConfig: {
    kmsKeyId: 'kmsKeyId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

## Properties

- `content`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnModelCard.ContentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnModelCard.ContentProperty.html) (required) — The content of the model card.

  Content uses the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema) .

- `createdBy`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnModelCard.UserContextProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnModelCard.UserContextProperty.html) — Information about the user who created or modified one or more of the following:.

  - Experiment
  - Trial
  - Trial component
  - Lineage group
  - Project
  - Model Card

- `lastModifiedBy`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnModelCard.UserContextProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnModelCard.UserContextProperty.html) — Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

- `modelCardName`: string (required) — The unique name of the model card.

- `modelCardStatus`: string (required) — The approval status of the model card within your organization.

  Different organizations might have different criteria for model card review and approval.

  - `Draft` : The model card is a work in progress.
  - `PendingReview` : The model card is pending review.
  - `Approved` : The model card is approved.
  - `Archived` : The model card is archived. No more updates should be made to the model card, but it can still be exported.

- `securityConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnModelCard.SecurityConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnModelCard.SecurityConfigProperty.html) — The security configuration used to protect model card data.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Key-value pairs used to manage metadata for the model card.