Package software.amazon.awscdk.services.sagemaker

Class CfnModelPackage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnModelPackage

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:09.733Z")
@Stability(Stable)
public class CfnModelPackage
extends CfnResource
implements IInspectable, ITaggable

A versioned model that can be deployed for SageMaker inference.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 Object modelInput;
 CfnModelPackage cfnModelPackage = CfnModelPackage.Builder.create(this, "MyCfnModelPackage")
         .additionalInferenceSpecifications(List.of(AdditionalInferenceSpecificationDefinitionProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataSource(ModelDataSourceProperty.builder()
                                 .s3DataSource(S3ModelDataSourceProperty.builder()
                                         .compressionType("compressionType")
                                         .s3DataType("s3DataType")
                                         .s3Uri("s3Uri")
                                         // the properties below are optional
                                         .modelAccessConfig(ModelAccessConfigProperty.builder()
                                                 .acceptEula(false)
                                                 .build())
                                         .build())
                                 .build())
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build()))
         .additionalInferenceSpecificationsToAdd(List.of(AdditionalInferenceSpecificationDefinitionProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataSource(ModelDataSourceProperty.builder()
                                 .s3DataSource(S3ModelDataSourceProperty.builder()
                                         .compressionType("compressionType")
                                         .s3DataType("s3DataType")
                                         .s3Uri("s3Uri")
                                         // the properties below are optional
                                         .modelAccessConfig(ModelAccessConfigProperty.builder()
                                                 .acceptEula(false)
                                                 .build())
                                         .build())
                                 .build())
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build()))
         .approvalDescription("approvalDescription")
         .certifyForMarketplace(false)
         .clientToken("clientToken")
         .customerMetadataProperties(Map.of(
                 "customerMetadataPropertiesKey", "customerMetadataProperties"))
         .domain("domain")
         .driftCheckBaselines(DriftCheckBaselinesProperty.builder()
                 .bias(DriftCheckBiasProperty.builder()
                         .configFile(FileSourceProperty.builder()
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .contentType("contentType")
                                 .build())
                         .postTrainingConstraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .preTrainingConstraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .explainability(DriftCheckExplainabilityProperty.builder()
                         .configFile(FileSourceProperty.builder()
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .contentType("contentType")
                                 .build())
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelDataQuality(DriftCheckModelDataQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelQuality(DriftCheckModelQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .build())
         .inferenceSpecification(InferenceSpecificationProperty.builder()
                 .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .containerHostname("containerHostname")
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .framework("framework")
                         .frameworkVersion("frameworkVersion")
                         .imageDigest("imageDigest")
                         .modelDataSource(ModelDataSourceProperty.builder()
                                 .s3DataSource(S3ModelDataSourceProperty.builder()
                                         .compressionType("compressionType")
                                         .s3DataType("s3DataType")
                                         .s3Uri("s3Uri")
                                         // the properties below are optional
                                         .modelAccessConfig(ModelAccessConfigProperty.builder()
                                                 .acceptEula(false)
                                                 .build())
                                         .build())
                                 .build())
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .build()))
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 // the properties below are optional
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build())
         .lastModifiedTime("lastModifiedTime")
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .modelApprovalStatus("modelApprovalStatus")
         .modelCard(ModelCardProperty.builder()
                 .modelCardContent("modelCardContent")
                 .modelCardStatus("modelCardStatus")
                 .build())
         .modelMetrics(ModelMetricsProperty.builder()
                 .bias(BiasProperty.builder()
                         .postTrainingReport(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .preTrainingReport(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .report(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .explainability(ExplainabilityProperty.builder()
                         .report(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelDataQuality(ModelDataQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .modelQuality(ModelQualityProperty.builder()
                         .constraints(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .statistics(MetricsSourceProperty.builder()
                                 .contentType("contentType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .contentDigest("contentDigest")
                                 .build())
                         .build())
                 .build())
         .modelPackageDescription("modelPackageDescription")
         .modelPackageGroupName("modelPackageGroupName")
         .modelPackageName("modelPackageName")
         .modelPackageStatusDetails(ModelPackageStatusDetailsProperty.builder()
                 .validationStatuses(List.of(ModelPackageStatusItemProperty.builder()
                         .name("name")
                         .status("status")
                         // the properties below are optional
                         .failureReason("failureReason")
                         .build()))
                 .build())
         .modelPackageVersion(123)
         .samplePayloadUrl("samplePayloadUrl")
         .securityConfig(SecurityConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .skipModelValidation("skipModelValidation")
         .sourceAlgorithmSpecification(SourceAlgorithmSpecificationProperty.builder()
                 .sourceAlgorithms(List.of(SourceAlgorithmProperty.builder()
                         .algorithmName("algorithmName")
                         // the properties below are optional
                         .modelDataUrl("modelDataUrl")
                         .build()))
                 .build())
         .sourceUri("sourceUri")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .task("task")
         .validationSpecification(ValidationSpecificationProperty.builder()
                 .validationProfiles(List.of(ValidationProfileProperty.builder()
                         .profileName("profileName")
                         .transformJobDefinition(TransformJobDefinitionProperty.builder()
                                 .transformInput(TransformInputProperty.builder()
                                         .dataSource(DataSourceProperty.builder()
                                                 .s3DataSource(S3DataSourceProperty.builder()
                                                         .s3DataType("s3DataType")
                                                         .s3Uri("s3Uri")
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .compressionType("compressionType")
                                         .contentType("contentType")
                                         .splitType("splitType")
                                         .build())
                                 .transformOutput(TransformOutputProperty.builder()
                                         .s3OutputPath("s3OutputPath")
                                         // the properties below are optional
                                         .accept("accept")
                                         .assembleWith("assembleWith")
                                         .kmsKeyId("kmsKeyId")
                                         .build())
                                 .transformResources(TransformResourcesProperty.builder()
                                         .instanceCount(123)
                                         .instanceType("instanceType")
                                         // the properties below are optional
                                         .volumeKmsKeyId("volumeKmsKeyId")
                                         .build())
                                 // the properties below are optional
                                 .batchStrategy("batchStrategy")
                                 .environment(Map.of(
                                         "environmentKey", "environment"))
                                 .maxConcurrentTransforms(123)
                                 .maxPayloadInMb(123)
                                 .build())
                         .build()))
                 .validationRole("validationRole")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty	A structure of additional Inference Specification.
static interface	CfnModelPackage.BiasProperty	Contains bias metrics for a model.
static final class	CfnModelPackage.Builder	A fluent builder for CfnModelPackage.
static interface	CfnModelPackage.DataSourceProperty	Describes the location of the channel data.
static interface	CfnModelPackage.DriftCheckBaselinesProperty	Represents the drift check baselines that can be used when the model monitor is set using the model package.
static interface	CfnModelPackage.DriftCheckBiasProperty	Represents the drift check bias baselines that can be used when the model monitor is set using the model package.
static interface	CfnModelPackage.DriftCheckExplainabilityProperty	Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.
static interface	CfnModelPackage.DriftCheckModelDataQualityProperty	Represents the drift check data quality baselines that can be used when the model monitor is set using the model package.
static interface	CfnModelPackage.DriftCheckModelQualityProperty	Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.
static interface	CfnModelPackage.ExplainabilityProperty	Contains explainability metrics for a model.
static interface	CfnModelPackage.FileSourceProperty	Contains details regarding the file source.
static interface	CfnModelPackage.InferenceSpecificationProperty	Defines how to perform inference generation after a training job is run.
static interface	CfnModelPackage.MetadataPropertiesProperty	Metadata properties of the tracking entity, trial, or trial component.
static interface	CfnModelPackage.MetricsSourceProperty	Details about the metrics source.
static interface	CfnModelPackage.ModelAccessConfigProperty	The access configuration file to control access to the ML model.
static interface	CfnModelPackage.ModelCardProperty	An Amazon SageMaker Model Card.
static interface	CfnModelPackage.ModelDataQualityProperty	Data quality constraints and statistics for a model.
static interface	CfnModelPackage.ModelDataSourceProperty	Specifies the location of ML model data to deploy.
static interface	CfnModelPackage.ModelInputProperty	Input object for the model.
static interface	CfnModelPackage.ModelMetricsProperty	Contains metrics captured from a model.
static interface	CfnModelPackage.ModelPackageContainerDefinitionProperty	Describes the Docker container for the model package.
static interface	CfnModelPackage.ModelPackageStatusDetailsProperty	Specifies the validation and image scan statuses of the model package.
static interface	CfnModelPackage.ModelPackageStatusItemProperty	Represents the overall status of a model package.
static interface	CfnModelPackage.ModelQualityProperty	Model quality statistics and constraints.
static interface	CfnModelPackage.S3DataSourceProperty	Describes the S3 data source.
static interface	CfnModelPackage.S3ModelDataSourceProperty	Specifies the S3 location of ML model data to deploy.
static interface	CfnModelPackage.SecurityConfigProperty	An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
static interface	CfnModelPackage.SourceAlgorithmProperty	Specifies an algorithm that was used to create the model package.
static interface	CfnModelPackage.SourceAlgorithmSpecificationProperty	A list of algorithms that were used to create a model package.
static interface	CfnModelPackage.TransformInputProperty	Describes the input source of a transform job and the way the transform job consumes it.
static interface	CfnModelPackage.TransformJobDefinitionProperty	Defines the input needed to run a transform job using the inference specification specified in the algorithm.
static interface	CfnModelPackage.TransformOutputProperty	Describes the results of a transform job.
static interface	CfnModelPackage.TransformResourcesProperty	Describes the resources, including ML instance types and ML instance count, to use for transform job.
static interface	CfnModelPackage.ValidationProfileProperty	Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
static interface	CfnModelPackage.ValidationSpecificationProperty	Specifies batch transform jobs that SageMaker runs to validate your model package.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnModelPackage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModelPackage(software.amazon.jsii.JsiiObjectRef objRef)
	CfnModelPackage(software.constructs.Construct scope, String id)
	CfnModelPackage(software.constructs.Construct scope, String id, CfnModelPackageProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAdditionalInferenceSpecifications()	An array of additional Inference Specification objects.
Object	getAdditionalInferenceSpecificationsToAdd()	An array of additional Inference Specification objects to be added to the existing array.
String	getApprovalDescription()	A description provided when the model approval is set.
String	getAttrCreationTime()	The time that the model package was created.
String	getAttrModelPackageArn()	The Amazon Resource Name (ARN) of the model package.
String	getAttrModelPackageStatus()	The status of the model package.
Object	getCertifyForMarketplace()	Whether the model package is to be certified to be listed on AWS Marketplace.
protected Map<String,Object>	getCfnProperties()
String	getClientToken()	A unique token that guarantees that the call to this API is idempotent.
Object	getCustomerMetadataProperties()	The metadata properties for the model package.
String	getDomain()	The machine learning domain of your model package and its components.
Object	getDriftCheckBaselines()	Represents the drift check baselines that can be used when the model monitor is set using the model package.
Object	getInferenceSpecification()	Defines how to perform inference generation after a training job is run.
String	getLastModifiedTime()	The last time the model package was modified.
Object	getMetadataProperties()	Metadata properties of the tracking entity, trial, or trial component.
String	getModelApprovalStatus()	The approval status of the model.
Object	getModelCard()	An Amazon SageMaker Model Card.
Object	getModelMetrics()	Metrics for the model.
String	getModelPackageDescription()	The description of the model package.
String	getModelPackageGroupName()	The model group to which the model belongs.
String	getModelPackageName()	The name of the model.
Object	getModelPackageStatusDetails()	Specifies the validation and image scan statuses of the model package.
Number	getModelPackageVersion()	The version number of a versioned model.
String	getSamplePayloadUrl()	The Amazon Simple Storage Service path where the sample payload are stored.
Object	getSecurityConfig()	An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
String	getSkipModelValidation()	Indicates if you want to skip model validation.
Object	getSourceAlgorithmSpecification()	A list of algorithms that were used to create a model package.
String	getSourceUri()	The URI of the source for the model package.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	A list of the tags associated with the model package.
String	getTask()	The machine learning task your model package accomplishes.
Object	getValidationSpecification()	Specifies batch transform jobs that SageMaker runs to validate your model package.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalInferenceSpecifications(List<Object> value)	An array of additional Inference Specification objects.
void	setAdditionalInferenceSpecifications(IResolvable value)	An array of additional Inference Specification objects.
void	setAdditionalInferenceSpecificationsToAdd(List<Object> value)	An array of additional Inference Specification objects to be added to the existing array.
void	setAdditionalInferenceSpecificationsToAdd(IResolvable value)	An array of additional Inference Specification objects to be added to the existing array.
void	setApprovalDescription(String value)	A description provided when the model approval is set.
void	setCertifyForMarketplace(Boolean value)	Whether the model package is to be certified to be listed on AWS Marketplace.
void	setCertifyForMarketplace(IResolvable value)	Whether the model package is to be certified to be listed on AWS Marketplace.
void	setClientToken(String value)	A unique token that guarantees that the call to this API is idempotent.
void	setCustomerMetadataProperties(Map<String,String> value)	The metadata properties for the model package.
void	setCustomerMetadataProperties(IResolvable value)	The metadata properties for the model package.
void	setDomain(String value)	The machine learning domain of your model package and its components.
void	setDriftCheckBaselines(IResolvable value)	Represents the drift check baselines that can be used when the model monitor is set using the model package.
void	setDriftCheckBaselines(CfnModelPackage.DriftCheckBaselinesProperty value)	Represents the drift check baselines that can be used when the model monitor is set using the model package.
void	setInferenceSpecification(IResolvable value)	Defines how to perform inference generation after a training job is run.
void	setInferenceSpecification(CfnModelPackage.InferenceSpecificationProperty value)	Defines how to perform inference generation after a training job is run.
void	setLastModifiedTime(String value)	The last time the model package was modified.
void	setMetadataProperties(IResolvable value)	Metadata properties of the tracking entity, trial, or trial component.
void	setMetadataProperties(CfnModelPackage.MetadataPropertiesProperty value)	Metadata properties of the tracking entity, trial, or trial component.
void	setModelApprovalStatus(String value)	The approval status of the model.
void	setModelCard(IResolvable value)	An Amazon SageMaker Model Card.
void	setModelCard(CfnModelPackage.ModelCardProperty value)	An Amazon SageMaker Model Card.
void	setModelMetrics(IResolvable value)	Metrics for the model.
void	setModelMetrics(CfnModelPackage.ModelMetricsProperty value)	Metrics for the model.
void	setModelPackageDescription(String value)	The description of the model package.
void	setModelPackageGroupName(String value)	The model group to which the model belongs.
void	setModelPackageName(String value)	The name of the model.
void	setModelPackageStatusDetails(IResolvable value)	Specifies the validation and image scan statuses of the model package.
void	setModelPackageStatusDetails(CfnModelPackage.ModelPackageStatusDetailsProperty value)	Specifies the validation and image scan statuses of the model package.
void	setModelPackageVersion(Number value)	The version number of a versioned model.
void	setSamplePayloadUrl(String value)	The Amazon Simple Storage Service path where the sample payload are stored.
void	setSecurityConfig(IResolvable value)	An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
void	setSecurityConfig(CfnModelPackage.SecurityConfigProperty value)	An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.
void	setSkipModelValidation(String value)	Indicates if you want to skip model validation.
void	setSourceAlgorithmSpecification(IResolvable value)	A list of algorithms that were used to create a model package.
void	setSourceAlgorithmSpecification(CfnModelPackage.SourceAlgorithmSpecificationProperty value)	A list of algorithms that were used to create a model package.
void	setSourceUri(String value)	The URI of the source for the model package.
void	setTagsRaw(List<CfnTag> value)	A list of the tags associated with the model package.
void	setTask(String value)	The machine learning task your model package accomplishes.
void	setValidationSpecification(IResolvable value)	Specifies batch transform jobs that SageMaker runs to validate your model package.
void	setValidationSpecification(CfnModelPackage.ValidationSpecificationProperty value)	Specifies batch transform jobs that SageMaker runs to validate your model package.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnModelPackage

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

CfnModelPackage

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

CfnModelPackage

@Stability(Stable)
public CfnModelPackage(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnModelPackageProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnModelPackage

@Stability(Stable)
public CfnModelPackage(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

The time that the model package was created.

getAttrModelPackageArn

@Stability(Stable)
@NotNull
public String getAttrModelPackageArn()

The Amazon Resource Name (ARN) of the model package.

getAttrModelPackageStatus

@Stability(Stable)
@NotNull
public String getAttrModelPackageStatus()

The status of the model package. This can be one of the following values.

• PENDING - The model package creation is pending.
• IN_PROGRESS - The model package is in the process of being created.
• COMPLETED - The model package was successfully created.
• FAILED - The model package creation failed.
• DELETING - The model package is in the process of being deleted.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAdditionalInferenceSpecifications

@Stability(Stable)
@Nullable
public Object getAdditionalInferenceSpecifications()

An array of additional Inference Specification objects.

setAdditionalInferenceSpecifications

@Stability(Stable)
public void setAdditionalInferenceSpecifications(@Nullable
 IResolvable value)

An array of additional Inference Specification objects.

setAdditionalInferenceSpecifications

@Stability(Stable)
public void setAdditionalInferenceSpecifications(@Nullable
 List<Object> value)

An array of additional Inference Specification objects.

getAdditionalInferenceSpecificationsToAdd

@Stability(Stable)
@Nullable
public Object getAdditionalInferenceSpecificationsToAdd()

An array of additional Inference Specification objects to be added to the existing array.

setAdditionalInferenceSpecificationsToAdd

@Stability(Stable)
public void setAdditionalInferenceSpecificationsToAdd(@Nullable
 IResolvable value)

An array of additional Inference Specification objects to be added to the existing array.

setAdditionalInferenceSpecificationsToAdd

@Stability(Stable)
public void setAdditionalInferenceSpecificationsToAdd(@Nullable
 List<Object> value)

An array of additional Inference Specification objects to be added to the existing array.

getApprovalDescription

@Stability(Stable)
@Nullable
public String getApprovalDescription()

A description provided when the model approval is set.

setApprovalDescription

@Stability(Stable)
public void setApprovalDescription(@Nullable
 String value)

A description provided when the model approval is set.

getCertifyForMarketplace

@Stability(Stable)
@Nullable
public Object getCertifyForMarketplace()

Whether the model package is to be certified to be listed on AWS Marketplace.

setCertifyForMarketplace

@Stability(Stable)
public void setCertifyForMarketplace(@Nullable
 Boolean value)

Whether the model package is to be certified to be listed on AWS Marketplace.

setCertifyForMarketplace

@Stability(Stable)
public void setCertifyForMarketplace(@Nullable
 IResolvable value)

Whether the model package is to be certified to be listed on AWS Marketplace.

getClientToken

@Stability(Stable)
@Nullable
public String getClientToken()

A unique token that guarantees that the call to this API is idempotent.

setClientToken

@Stability(Stable)
public void setClientToken(@Nullable
 String value)

A unique token that guarantees that the call to this API is idempotent.

getCustomerMetadataProperties

@Stability(Stable)
@Nullable
public Object getCustomerMetadataProperties()

The metadata properties for the model package.

setCustomerMetadataProperties

@Stability(Stable)
public void setCustomerMetadataProperties(@Nullable
 IResolvable value)

The metadata properties for the model package.

setCustomerMetadataProperties

@Stability(Stable)
public void setCustomerMetadataProperties(@Nullable
 Map<String,String> value)

The metadata properties for the model package.

getDomain

@Stability(Stable)
@Nullable
public String getDomain()

The machine learning domain of your model package and its components.

setDomain

@Stability(Stable)
public void setDomain(@Nullable
 String value)

The machine learning domain of your model package and its components.

getDriftCheckBaselines

@Stability(Stable)
@Nullable
public Object getDriftCheckBaselines()

Represents the drift check baselines that can be used when the model monitor is set using the model package.

setDriftCheckBaselines

@Stability(Stable)
public void setDriftCheckBaselines(@Nullable
 IResolvable value)

Represents the drift check baselines that can be used when the model monitor is set using the model package.

setDriftCheckBaselines

@Stability(Stable)
public void setDriftCheckBaselines(@Nullable
 CfnModelPackage.DriftCheckBaselinesProperty value)

Represents the drift check baselines that can be used when the model monitor is set using the model package.

getInferenceSpecification

@Stability(Stable)
@Nullable
public Object getInferenceSpecification()

Defines how to perform inference generation after a training job is run.

setInferenceSpecification

@Stability(Stable)
public void setInferenceSpecification(@Nullable
 IResolvable value)

Defines how to perform inference generation after a training job is run.

setInferenceSpecification

@Stability(Stable)
public void setInferenceSpecification(@Nullable
 CfnModelPackage.InferenceSpecificationProperty value)

Defines how to perform inference generation after a training job is run.

getLastModifiedTime

@Stability(Stable)
@Nullable
public String getLastModifiedTime()

The last time the model package was modified.

setLastModifiedTime

@Stability(Stable)
public void setLastModifiedTime(@Nullable
 String value)

The last time the model package was modified.

getMetadataProperties

@Stability(Stable)
@Nullable
public Object getMetadataProperties()

Metadata properties of the tracking entity, trial, or trial component.

setMetadataProperties

@Stability(Stable)
public void setMetadataProperties(@Nullable
 IResolvable value)

Metadata properties of the tracking entity, trial, or trial component.

setMetadataProperties

@Stability(Stable)
public void setMetadataProperties(@Nullable
 CfnModelPackage.MetadataPropertiesProperty value)

Metadata properties of the tracking entity, trial, or trial component.

getModelApprovalStatus

@Stability(Stable)
@Nullable
public String getModelApprovalStatus()

The approval status of the model.

This can be one of the following values.

setModelApprovalStatus

@Stability(Stable)
public void setModelApprovalStatus(@Nullable
 String value)

The approval status of the model.

This can be one of the following values.

getModelCard

@Stability(Stable)
@Nullable
public Object getModelCard()

An Amazon SageMaker Model Card.

setModelCard

@Stability(Stable)
public void setModelCard(@Nullable
 IResolvable value)

An Amazon SageMaker Model Card.

setModelCard

@Stability(Stable)
public void setModelCard(@Nullable
 CfnModelPackage.ModelCardProperty value)

An Amazon SageMaker Model Card.

getModelMetrics

@Stability(Stable)
@Nullable
public Object getModelMetrics()

Metrics for the model.

setModelMetrics

@Stability(Stable)
public void setModelMetrics(@Nullable
 IResolvable value)

Metrics for the model.

setModelMetrics

@Stability(Stable)
public void setModelMetrics(@Nullable
 CfnModelPackage.ModelMetricsProperty value)

Metrics for the model.

getModelPackageDescription

@Stability(Stable)
@Nullable
public String getModelPackageDescription()

The description of the model package.

setModelPackageDescription

@Stability(Stable)
public void setModelPackageDescription(@Nullable
 String value)

The description of the model package.

getModelPackageGroupName

@Stability(Stable)
@Nullable
public String getModelPackageGroupName()

The model group to which the model belongs.

setModelPackageGroupName

@Stability(Stable)
public void setModelPackageGroupName(@Nullable
 String value)

The model group to which the model belongs.

getModelPackageName

@Stability(Stable)
@Nullable
public String getModelPackageName()

The name of the model.

setModelPackageName

@Stability(Stable)
public void setModelPackageName(@Nullable
 String value)

The name of the model.

getModelPackageStatusDetails

@Stability(Stable)
@Nullable
public Object getModelPackageStatusDetails()

Specifies the validation and image scan statuses of the model package.

setModelPackageStatusDetails

@Stability(Stable)
public void setModelPackageStatusDetails(@Nullable
 IResolvable value)

Specifies the validation and image scan statuses of the model package.

setModelPackageStatusDetails

@Stability(Stable)
public void setModelPackageStatusDetails(@Nullable
 CfnModelPackage.ModelPackageStatusDetailsProperty value)

Specifies the validation and image scan statuses of the model package.

getModelPackageVersion

@Stability(Stable)
@Nullable
public Number getModelPackageVersion()

The version number of a versioned model.

setModelPackageVersion

@Stability(Stable)
public void setModelPackageVersion(@Nullable
 Number value)

The version number of a versioned model.

getSamplePayloadUrl

@Stability(Stable)
@Nullable
public String getSamplePayloadUrl()

The Amazon Simple Storage Service path where the sample payload are stored.

setSamplePayloadUrl

@Stability(Stable)
public void setSamplePayloadUrl(@Nullable
 String value)

The Amazon Simple Storage Service path where the sample payload are stored.

getSecurityConfig

@Stability(Stable)
@Nullable
public Object getSecurityConfig()

An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

setSecurityConfig

@Stability(Stable)
public void setSecurityConfig(@Nullable
 IResolvable value)

An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

setSecurityConfig

@Stability(Stable)
public void setSecurityConfig(@Nullable
 CfnModelPackage.SecurityConfigProperty value)

An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

getSkipModelValidation

@Stability(Stable)
@Nullable
public String getSkipModelValidation()

Indicates if you want to skip model validation.

setSkipModelValidation

@Stability(Stable)
public void setSkipModelValidation(@Nullable
 String value)

Indicates if you want to skip model validation.

getSourceAlgorithmSpecification

@Stability(Stable)
@Nullable
public Object getSourceAlgorithmSpecification()

A list of algorithms that were used to create a model package.

setSourceAlgorithmSpecification

@Stability(Stable)
public void setSourceAlgorithmSpecification(@Nullable
 IResolvable value)

A list of algorithms that were used to create a model package.

setSourceAlgorithmSpecification

@Stability(Stable)
public void setSourceAlgorithmSpecification(@Nullable
 CfnModelPackage.SourceAlgorithmSpecificationProperty value)

A list of algorithms that were used to create a model package.

getSourceUri

@Stability(Stable)
@Nullable
public String getSourceUri()

The URI of the source for the model package.

setSourceUri

@Stability(Stable)
public void setSourceUri(@Nullable
 String value)

The URI of the source for the model package.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

A list of the tags associated with the model package.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

A list of the tags associated with the model package.

getTask

@Stability(Stable)
@Nullable
public String getTask()

The machine learning task your model package accomplishes.

setTask

@Stability(Stable)
public void setTask(@Nullable
 String value)

The machine learning task your model package accomplishes.

getValidationSpecification

@Stability(Stable)
@Nullable
public Object getValidationSpecification()

Specifies batch transform jobs that SageMaker runs to validate your model package.

setValidationSpecification

@Stability(Stable)
public void setValidationSpecification(@Nullable
 IResolvable value)

Specifies batch transform jobs that SageMaker runs to validate your model package.

setValidationSpecification

@Stability(Stable)
public void setValidationSpecification(@Nullable
 CfnModelPackage.ValidationSpecificationProperty value)

Specifies batch transform jobs that SageMaker runs to validate your model package.