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

Class CfnModelCardPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnModelCardPropsMixin

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.014Z")
@Stability(Stable)
public class CfnModelCardPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card .

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;
 Object value;
 CfnModelCardPropsMixin cfnModelCardPropsMixin = CfnModelCardPropsMixin.Builder.create(CfnModelCardMixinProps.builder()
         .content(ContentProperty.builder()
                 .additionalInformation(AdditionalInformationProperty.builder()
                         .caveatsAndRecommendations("caveatsAndRecommendations")
                         .customDetails(Map.of(
                                 "customDetailsKey", "customDetails"))
                         .ethicalConsiderations("ethicalConsiderations")
                         .build())
                 .businessDetails(BusinessDetailsProperty.builder()
                         .businessProblem("businessProblem")
                         .businessStakeholders("businessStakeholders")
                         .lineOfBusiness("lineOfBusiness")
                         .build())
                 .evaluationDetails(List.of(EvaluationDetailProperty.builder()
                         .datasets(List.of("datasets"))
                         .evaluationJobArn("evaluationJobArn")
                         .evaluationObservation("evaluationObservation")
                         .metadata(Map.of(
                                 "metadataKey", "metadata"))
                         .metricGroups(List.of(MetricGroupProperty.builder()
                                 .metricData(List.of(MetricDataItemsProperty.builder()
                                         .name("name")
                                         .notes("notes")
                                         .type("type")
                                         .value(value)
                                         .xAxisName(List.of("xAxisName"))
                                         .yAxisName(List.of("yAxisName"))
                                         .build()))
                                 .name("name")
                                 .build()))
                         .name("name")
                         .build()))
                 .intendedUses(IntendedUsesProperty.builder()
                         .explanationsForRiskRating("explanationsForRiskRating")
                         .factorsAffectingModelEfficiency("factorsAffectingModelEfficiency")
                         .intendedUses("intendedUses")
                         .purposeOfModel("purposeOfModel")
                         .riskRating("riskRating")
                         .build())
                 .modelOverview(ModelOverviewProperty.builder()
                         .algorithmType("algorithmType")
                         .inferenceEnvironment(InferenceEnvironmentProperty.builder()
                                 .containerImage(List.of("containerImage"))
                                 .build())
                         .modelArtifact(List.of("modelArtifact"))
                         .modelCreator("modelCreator")
                         .modelDescription("modelDescription")
                         .modelId("modelId")
                         .modelName("modelName")
                         .modelOwner("modelOwner")
                         .modelVersion(123)
                         .problemType("problemType")
                         .build())
                 .modelPackageDetails(ModelPackageDetailsProperty.builder()
                         .approvalDescription("approvalDescription")
                         .createdBy(ModelPackageCreatorProperty.builder()
                                 .userProfileName("userProfileName")
                                 .build())
                         .domain("domain")
                         .inferenceSpecification(InferenceSpecificationProperty.builder()
                                 .containers(List.of(ContainerProperty.builder()
                                         .image("image")
                                         .modelDataUrl("modelDataUrl")
                                         .nearestModelName("nearestModelName")
                                         .build()))
                                 .build())
                         .modelApprovalStatus("modelApprovalStatus")
                         .modelPackageArn("modelPackageArn")
                         .modelPackageDescription("modelPackageDescription")
                         .modelPackageGroupName("modelPackageGroupName")
                         .modelPackageName("modelPackageName")
                         .modelPackageStatus("modelPackageStatus")
                         .modelPackageVersion(123)
                         .sourceAlgorithms(List.of(SourceAlgorithmProperty.builder()
                                 .algorithmName("algorithmName")
                                 .modelDataUrl("modelDataUrl")
                                 .build()))
                         .task("task")
                         .build())
                 .trainingDetails(TrainingDetailsProperty.builder()
                         .objectiveFunction(ObjectiveFunctionProperty.builder()
                                 .function(FunctionProperty.builder()
                                         .condition("condition")
                                         .facet("facet")
                                         .function("function")
                                         .build())
                                 .notes("notes")
                                 .build())
                         .trainingJobDetails(TrainingJobDetailsProperty.builder()
                                 .hyperParameters(List.of(TrainingHyperParameterProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .trainingArn("trainingArn")
                                 .trainingDatasets(List.of("trainingDatasets"))
                                 .trainingEnvironment(TrainingEnvironmentProperty.builder()
                                         .containerImage(List.of("containerImage"))
                                         .build())
                                 .trainingMetrics(List.of(TrainingMetricProperty.builder()
                                         .name("name")
                                         .notes("notes")
                                         .value(123)
                                         .build()))
                                 .userProvidedHyperParameters(List.of(TrainingHyperParameterProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .userProvidedTrainingMetrics(List.of(TrainingMetricProperty.builder()
                                         .name("name")
                                         .notes("notes")
                                         .value(123)
                                         .build()))
                                 .build())
                         .trainingObservations("trainingObservations")
                         .build())
                 .build())
         .createdBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .lastModifiedBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .modelCardName("modelCardName")
         .modelCardStatus("modelCardStatus")
         .securityConfig(SecurityConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnModelCardPropsMixin.AdditionalInformationProperty	Additional information about the model.
static final class	CfnModelCardPropsMixin.Builder	A fluent builder for CfnModelCardPropsMixin.
static interface	CfnModelCardPropsMixin.BusinessDetailsProperty	Information about how the model supports business goals.
static interface	CfnModelCardPropsMixin.ContainerProperty	Example:
static interface	CfnModelCardPropsMixin.ContentProperty	The content of the model card.
static interface	CfnModelCardPropsMixin.EvaluationDetailProperty	The evaluation details of the model.
static interface	CfnModelCardPropsMixin.FunctionProperty	Function details.
static interface	CfnModelCardPropsMixin.InferenceEnvironmentProperty	An overview of a model's inference environment.
static interface	CfnModelCardPropsMixin.InferenceSpecificationProperty	Defines how to perform inference generation after a training job is run.
static interface	CfnModelCardPropsMixin.IntendedUsesProperty	The intended uses of a model.
static interface	CfnModelCardPropsMixin.MetricDataItemsProperty	Metric data.
static interface	CfnModelCardPropsMixin.MetricGroupProperty	A group of metric data that you use to initialize a metric group object.
static interface	CfnModelCardPropsMixin.ModelOverviewProperty	An overview about the model.
static interface	CfnModelCardPropsMixin.ModelPackageCreatorProperty	Example:
static interface	CfnModelCardPropsMixin.ModelPackageDetailsProperty	Metadata information related to model package version.
static interface	CfnModelCardPropsMixin.ObjectiveFunctionProperty	The function that is optimized during model training.
static interface	CfnModelCardPropsMixin.SecurityConfigProperty	The security configuration used to protect model card data.
static interface	CfnModelCardPropsMixin.SourceAlgorithmProperty	Specifies an algorithm that was used to create the model package.
static interface	CfnModelCardPropsMixin.TrainingDetailsProperty	The training details of the model.
static interface	CfnModelCardPropsMixin.TrainingEnvironmentProperty	SageMaker AI training image.
static interface	CfnModelCardPropsMixin.TrainingHyperParameterProperty	A hyper parameter that was configured in training the model.
static interface	CfnModelCardPropsMixin.TrainingJobDetailsProperty	The overview of a training job.
static interface	CfnModelCardPropsMixin.TrainingMetricProperty	A result from a SageMaker AI training job.
static interface	CfnModelCardPropsMixin.UserContextProperty	Information about the user who created or modified a SageMaker resource.

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
	CfnModelCardPropsMixin(CfnModelCardMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::ModelCard.
	CfnModelCardPropsMixin(CfnModelCardMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::ModelCard.
protected	CfnModelCardPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModelCardPropsMixin(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 CfnModelCardMixinProps	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

CfnModelCardPropsMixin

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

CfnModelCardPropsMixin

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

CfnModelCardPropsMixin

@Stability(Stable)
public CfnModelCardPropsMixin(@NotNull
 CfnModelCardMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnModelCardPropsMixin

@Stability(Stable)
public CfnModelCardPropsMixin(@NotNull
 CfnModelCardMixinProps props)

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

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 CfnModelCardMixinProps getProps()

getStrategy

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