CfnModelPackage

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.sagemaker.CfnModelPackage

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:25.477Z")
public class CfnModelPackage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::ModelPackage`.

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")
         .additionalInferenceSpecificationDefinition(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")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .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())
         .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")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .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")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .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")
         .createdBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .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())
         .environment(Map.of(
                 "environmentKey", "environment"))
         .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")
                         .modelDataUrl("modelDataUrl")
                         .modelInput(modelInput)
                         .nearestModelName("nearestModelName")
                         .productId("productId")
                         .build()))
                 .supportedContentTypes(List.of("supportedContentTypes"))
                 .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))
                 // the properties below are optional
                 .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
                 .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
                 .build())
         .lastModifiedBy(UserContextProperty.builder()
                 .domainId("domainId")
                 .userProfileArn("userProfileArn")
                 .userProfileName("userProfileName")
                 .build())
         .lastModifiedTime("lastModifiedTime")
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .modelApprovalStatus("modelApprovalStatus")
         .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()))
                 // the properties below are optional
                 .imageScanStatuses(List.of(ModelPackageStatusItemProperty.builder()
                         .name("name")
                         .status("status")
                         // the properties below are optional
                         .failureReason("failureReason")
                         .build()))
                 .build())
         .modelPackageStatusItem(ModelPackageStatusItemProperty.builder()
                 .name("name")
                 .status("status")
                 // the properties below are optional
                 .failureReason("failureReason")
                 .build())
         .modelPackageVersion(123)
         .samplePayloadUrl("samplePayloadUrl")
         .sourceAlgorithmSpecification(SourceAlgorithmSpecificationProperty.builder()
                 .sourceAlgorithms(List.of(SourceAlgorithmProperty.builder()
                         .algorithmName("algorithmName")
                         // the properties below are optional
                         .modelDataUrl("modelDataUrl")
                         .build()))
                 .build())
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty` A structure of additional Inference Specification.
`static interface`	`CfnModelPackage.BiasProperty` Contains bias metrics for a model.
`static 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.ModelDataQualityProperty` Data quality constraints and statistics for a model.
`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.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.UserContextProperty` Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
`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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnModelPackage(Construct scope, java.lang.String id)` Create a new `AWS::SageMaker::ModelPackage`.
	`CfnModelPackage(Construct scope, java.lang.String id, CfnModelPackageProps props)` Create a new `AWS::SageMaker::ModelPackage`.
`protected`	`CfnModelPackage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnModelPackage(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAdditionalInferenceSpecificationDefinition()` A structure of additional Inference Specification.
`java.lang.Object`	`getAdditionalInferenceSpecifications()` An array of additional Inference Specification objects.
`java.lang.Object`	`getAdditionalInferenceSpecificationsToAdd()` An array of additional Inference Specification objects to be added to the existing array.
`java.lang.String`	`getApprovalDescription()` A description provided when the model approval is set.
`java.lang.String`	`getAttrCreationTime()` The time that the model package was created.
`java.lang.String`	`getAttrModelPackageArn()` The Amazon Resource Name (ARN) of the model package.
`java.lang.String`	`getAttrModelPackageStatus()` The status of the model package.
`java.lang.Object`	`getCertifyForMarketplace()` Whether the model package is to be certified to be listed on AWS Marketplace.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getClientToken()` A unique token that guarantees that the call to this API is idempotent.
`java.lang.Object`	`getCreatedBy()` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`java.lang.Object`	`getCustomerMetadataProperties()` The metadata properties for the model package.
`java.lang.String`	`getDomain()` The machine learning domain of your model package and its components.
`java.lang.Object`	`getDriftCheckBaselines()` Represents the drift check baselines that can be used when the model monitor is set using the model package.
`java.lang.Object`	`getEnvironment()` The environment variables to set in the Docker container.
`java.lang.Object`	`getInferenceSpecification()` Defines how to perform inference generation after a training job is run.
`java.lang.Object`	`getLastModifiedBy()` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`java.lang.String`	`getLastModifiedTime()` The last time the model package was modified.
`java.lang.Object`	`getMetadataProperties()` Metadata properties of the tracking entity, trial, or trial component.
`java.lang.String`	`getModelApprovalStatus()` The approval status of the model.
`java.lang.Object`	`getModelMetrics()` Metrics for the model.
`java.lang.String`	`getModelPackageDescription()` The description of the model package.
`java.lang.String`	`getModelPackageGroupName()` The model group to which the model belongs.
`java.lang.String`	`getModelPackageName()` The name of the model.
`java.lang.Object`	`getModelPackageStatusDetails()` Specifies the validation and image scan statuses of the model package.
`java.lang.Object`	`getModelPackageStatusItem()` Represents the overall status of a model package.
`java.lang.Number`	`getModelPackageVersion()` The version number of a versioned model.
`java.lang.String`	`getSamplePayloadUrl()` The Amazon Simple Storage Service path where the sample payload are stored.
`java.lang.Object`	`getSourceAlgorithmSpecification()` A list of algorithms that were used to create a model package.
`TagManager`	`getTags()` A list of the tags associated with the model package.
`java.lang.String`	`getTask()` The machine learning task your model package accomplishes.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAdditionalInferenceSpecificationDefinition(CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty value)` A structure of additional Inference Specification.
`void`	`setAdditionalInferenceSpecificationDefinition(IResolvable value)` A structure of additional Inference Specification.
`void`	`setAdditionalInferenceSpecifications(IResolvable value)` An array of additional Inference Specification objects.
`void`	`setAdditionalInferenceSpecifications(java.util.List<java.lang.Object> value)` An array of additional Inference Specification objects.
`void`	`setAdditionalInferenceSpecificationsToAdd(IResolvable value)` An array of additional Inference Specification objects to be added to the existing array.
`void`	`setAdditionalInferenceSpecificationsToAdd(java.util.List<java.lang.Object> value)` An array of additional Inference Specification objects to be added to the existing array.
`void`	`setApprovalDescription(java.lang.String value)` A description provided when the model approval is set.
`void`	`setCertifyForMarketplace(java.lang.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(java.lang.String value)` A unique token that guarantees that the call to this API is idempotent.
`void`	`setCreatedBy(CfnModelPackage.UserContextProperty value)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`void`	`setCreatedBy(IResolvable value)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`void`	`setCustomerMetadataProperties(IResolvable value)` The metadata properties for the model package.
`void`	`setCustomerMetadataProperties(java.util.Map<java.lang.String,java.lang.String> value)` The metadata properties for the model package.
`void`	`setDomain(java.lang.String value)` The machine learning domain of your model package and its components.
`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`	`setDriftCheckBaselines(IResolvable value)` Represents the drift check baselines that can be used when the model monitor is set using the model package.
`void`	`setEnvironment(IResolvable value)` The environment variables to set in the Docker container.
`void`	`setEnvironment(java.util.Map<java.lang.String,java.lang.String> value)` The environment variables to set in the Docker container.
`void`	`setInferenceSpecification(CfnModelPackage.InferenceSpecificationProperty value)` Defines how to perform inference generation after a training job is run.
`void`	`setInferenceSpecification(IResolvable value)` Defines how to perform inference generation after a training job is run.
`void`	`setLastModifiedBy(CfnModelPackage.UserContextProperty value)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`void`	`setLastModifiedBy(IResolvable value)` Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
`void`	`setLastModifiedTime(java.lang.String value)` The last time the model package was modified.
`void`	`setMetadataProperties(CfnModelPackage.MetadataPropertiesProperty value)` Metadata properties of the tracking entity, trial, or trial component.
`void`	`setMetadataProperties(IResolvable value)` Metadata properties of the tracking entity, trial, or trial component.
`void`	`setModelApprovalStatus(java.lang.String value)` The approval status of the model.
`void`	`setModelMetrics(CfnModelPackage.ModelMetricsProperty value)` Metrics for the model.
`void`	`setModelMetrics(IResolvable value)` Metrics for the model.
`void`	`setModelPackageDescription(java.lang.String value)` The description of the model package.
`void`	`setModelPackageGroupName(java.lang.String value)` The model group to which the model belongs.
`void`	`setModelPackageName(java.lang.String value)` The name of the model.
`void`	`setModelPackageStatusDetails(CfnModelPackage.ModelPackageStatusDetailsProperty value)` Specifies the validation and image scan statuses of the model package.
`void`	`setModelPackageStatusDetails(IResolvable value)` Specifies the validation and image scan statuses of the model package.
`void`	`setModelPackageStatusItem(CfnModelPackage.ModelPackageStatusItemProperty value)` Represents the overall status of a model package.
`void`	`setModelPackageStatusItem(IResolvable value)` Represents the overall status of a model package.
`void`	`setModelPackageVersion(java.lang.Number value)` The version number of a versioned model.
`void`	`setSamplePayloadUrl(java.lang.String value)` The Amazon Simple Storage Service path where the sample payload are stored.
`void`	`setSourceAlgorithmSpecification(CfnModelPackage.SourceAlgorithmSpecificationProperty value)` A list of algorithms that were used to create a model package.
`void`	`setSourceAlgorithmSpecification(IResolvable value)` A list of algorithms that were used to create a model package.
`void`	`setTask(java.lang.String value)` The machine learning task your model package accomplishes.
`void`	`setValidationSpecification(CfnModelPackage.ValidationSpecificationProperty value)` Specifies batch transform jobs that SageMaker runs to validate your model package.
`void`	`setValidationSpecification(IResolvable value)` Specifies batch transform jobs that SageMaker runs to validate your model package.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnModelPackage
```
protected CfnModelPackage(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnModelPackage
```
protected CfnModelPackage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnModelPackage
```
public CfnModelPackage(Construct scope,
                       java.lang.String id,
                       CfnModelPackageProps props)
```
    Create a new `AWS::SageMaker::ModelPackage`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnModelPackage
```
public CfnModelPackage(Construct scope,
                       java.lang.String id)
```
    Create a new `AWS::SageMaker::ModelPackage`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrCreationTime
```
public java.lang.String getAttrCreationTime()
```
    The time that the model package was created.
  - getAttrModelPackageArn
```
public java.lang.String getAttrModelPackageArn()
```
    The Amazon Resource Name (ARN) of the model package.
  - getAttrModelPackageStatus
```
public java.lang.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
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    A list of the tags associated with the model package.
    For more information, see Tagging AWS resources in the AWS General Reference Guide .
  - getAdditionalInferenceSpecificationDefinition
```
public java.lang.Object getAdditionalInferenceSpecificationDefinition()
```
    A structure of additional Inference Specification.
    Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
  - setAdditionalInferenceSpecificationDefinition
```
public void setAdditionalInferenceSpecificationDefinition(IResolvable value)
```
    A structure of additional Inference Specification.
    Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
  - setAdditionalInferenceSpecificationDefinition
```
public void setAdditionalInferenceSpecificationDefinition(CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty value)
```
    A structure of additional Inference Specification.
    Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package
  - getAdditionalInferenceSpecifications
```
public java.lang.Object getAdditionalInferenceSpecifications()
```
    An array of additional Inference Specification objects.
  - setAdditionalInferenceSpecifications
```
public void setAdditionalInferenceSpecifications(IResolvable value)
```
    An array of additional Inference Specification objects.
  - setAdditionalInferenceSpecifications
```
public void setAdditionalInferenceSpecifications(java.util.List<java.lang.Object> value)
```
    An array of additional Inference Specification objects.
  - getAdditionalInferenceSpecificationsToAdd
```
public java.lang.Object getAdditionalInferenceSpecificationsToAdd()
```
    An array of additional Inference Specification objects to be added to the existing array.
    The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
  - setAdditionalInferenceSpecificationsToAdd
```
public void setAdditionalInferenceSpecificationsToAdd(IResolvable value)
```
    An array of additional Inference Specification objects to be added to the existing array.
    The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
  - setAdditionalInferenceSpecificationsToAdd
```
public void setAdditionalInferenceSpecificationsToAdd(java.util.List<java.lang.Object> value)
```
    An array of additional Inference Specification objects to be added to the existing array.
    The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
  - getApprovalDescription
```
public java.lang.String getApprovalDescription()
```
    A description provided when the model approval is set.
  - setApprovalDescription
```
public void setApprovalDescription(java.lang.String value)
```
    A description provided when the model approval is set.
  - getCertifyForMarketplace
```
public java.lang.Object getCertifyForMarketplace()
```
    Whether the model package is to be certified to be listed on AWS Marketplace.
    For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
  - setCertifyForMarketplace
```
public void setCertifyForMarketplace(java.lang.Boolean value)
```
    Whether the model package is to be certified to be listed on AWS Marketplace.
    For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
  - setCertifyForMarketplace
```
public void setCertifyForMarketplace(IResolvable value)
```
    Whether the model package is to be certified to be listed on AWS Marketplace.
    For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
  - getClientToken
```
public java.lang.String getClientToken()
```
    A unique token that guarantees that the call to this API is idempotent.
  - setClientToken
```
public void setClientToken(java.lang.String value)
```
    A unique token that guarantees that the call to this API is idempotent.
  - getCreatedBy
```
public java.lang.Object getCreatedBy()
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - setCreatedBy
```
public void setCreatedBy(IResolvable value)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - setCreatedBy
```
public void setCreatedBy(CfnModelPackage.UserContextProperty value)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - getCustomerMetadataProperties
```
public java.lang.Object getCustomerMetadataProperties()
```
    The metadata properties for the model package.
  - setCustomerMetadataProperties
```
public void setCustomerMetadataProperties(IResolvable value)
```
    The metadata properties for the model package.
  - setCustomerMetadataProperties
```
public void setCustomerMetadataProperties(java.util.Map<java.lang.String,java.lang.String> value)
```
    The metadata properties for the model package.
  - getDomain
```
public java.lang.String getDomain()
```
    The machine learning domain of your model package and its components.
    Common machine learning domains include computer vision and natural language processing.
  - setDomain
```
public void setDomain(java.lang.String value)
```
    The machine learning domain of your model package and its components.
    Common machine learning domains include computer vision and natural language processing.
  - getDriftCheckBaselines
```
public java.lang.Object getDriftCheckBaselines()
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
  - setDriftCheckBaselines
```
public void setDriftCheckBaselines(IResolvable value)
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
  - setDriftCheckBaselines
```
public void setDriftCheckBaselines(CfnModelPackage.DriftCheckBaselinesProperty value)
```
    Represents the drift check baselines that can be used when the model monitor is set using the model package.
  - getEnvironment
```
public java.lang.Object getEnvironment()
```
    The environment variables to set in the Docker container.
    Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.
  - setEnvironment
```
public void setEnvironment(IResolvable value)
```
    The environment variables to set in the Docker container.
    Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.
  - setEnvironment
```
public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> value)
```
    The environment variables to set in the Docker container.
    Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.
  - getInferenceSpecification
```
public java.lang.Object getInferenceSpecification()
```
    Defines how to perform inference generation after a training job is run.
  - setInferenceSpecification
```
public void setInferenceSpecification(IResolvable value)
```
    Defines how to perform inference generation after a training job is run.
  - setInferenceSpecification
```
public void setInferenceSpecification(CfnModelPackage.InferenceSpecificationProperty value)
```
    Defines how to perform inference generation after a training job is run.
  - getLastModifiedBy
```
public java.lang.Object getLastModifiedBy()
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - setLastModifiedBy
```
public void setLastModifiedBy(IResolvable value)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - setLastModifiedBy
```
public void setLastModifiedBy(CfnModelPackage.UserContextProperty value)
```
    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
  - getLastModifiedTime
```
public java.lang.String getLastModifiedTime()
```
    The last time the model package was modified.
  - setLastModifiedTime
```
public void setLastModifiedTime(java.lang.String value)
```
    The last time the model package was modified.
  - getMetadataProperties
```
public java.lang.Object getMetadataProperties()
```
    Metadata properties of the tracking entity, trial, or trial component.
  - setMetadataProperties
```
public void setMetadataProperties(IResolvable value)
```
    Metadata properties of the tracking entity, trial, or trial component.
  - setMetadataProperties
```
public void setMetadataProperties(CfnModelPackage.MetadataPropertiesProperty value)
```
    Metadata properties of the tracking entity, trial, or trial component.
  - getModelApprovalStatus
```
public java.lang.String getModelApprovalStatus()
```
    The approval status of the model. This can be one of the following values.
    - APPROVED - The model is approved
    - REJECTED - The model is rejected.
    - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
  - setModelApprovalStatus
```
public void setModelApprovalStatus(java.lang.String value)
```
    The approval status of the model. This can be one of the following values.
    - APPROVED - The model is approved
    - REJECTED - The model is rejected.
    - PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
  - getModelMetrics
```
public java.lang.Object getModelMetrics()
```
    Metrics for the model.
  - setModelMetrics
```
public void setModelMetrics(IResolvable value)
```
    Metrics for the model.
  - setModelMetrics
```
public void setModelMetrics(CfnModelPackage.ModelMetricsProperty value)
```
    Metrics for the model.
  - getModelPackageDescription
```
public java.lang.String getModelPackageDescription()
```
    The description of the model package.
  - setModelPackageDescription
```
public void setModelPackageDescription(java.lang.String value)
```
    The description of the model package.
  - getModelPackageGroupName
```
public java.lang.String getModelPackageGroupName()
```
    The model group to which the model belongs.
  - setModelPackageGroupName
```
public void setModelPackageGroupName(java.lang.String value)
```
    The model group to which the model belongs.
  - getModelPackageName
```
public java.lang.String getModelPackageName()
```
    The name of the model.
  - setModelPackageName
```
public void setModelPackageName(java.lang.String value)
```
    The name of the model.
  - getModelPackageStatusDetails
```
public java.lang.Object getModelPackageStatusDetails()
```
    Specifies the validation and image scan statuses of the model package.
  - setModelPackageStatusDetails
```
public void setModelPackageStatusDetails(IResolvable value)
```
    Specifies the validation and image scan statuses of the model package.
  - setModelPackageStatusDetails
```
public void setModelPackageStatusDetails(CfnModelPackage.ModelPackageStatusDetailsProperty value)
```
    Specifies the validation and image scan statuses of the model package.
  - getModelPackageStatusItem
```
public java.lang.Object getModelPackageStatusItem()
```
    Represents the overall status of a model package.
  - setModelPackageStatusItem
```
public void setModelPackageStatusItem(IResolvable value)
```
    Represents the overall status of a model package.
  - setModelPackageStatusItem
```
public void setModelPackageStatusItem(CfnModelPackage.ModelPackageStatusItemProperty value)
```
    Represents the overall status of a model package.
  - getModelPackageVersion
```
public java.lang.Number getModelPackageVersion()
```
    The version number of a versioned model.
  - setModelPackageVersion
```
public void setModelPackageVersion(java.lang.Number value)
```
    The version number of a versioned model.
  - getSamplePayloadUrl
```
public java.lang.String getSamplePayloadUrl()
```
    The Amazon Simple Storage Service path where the sample payload are stored.
    This path must point to a single gzip compressed tar archive (.tar.gz suffix).
  - setSamplePayloadUrl
```
public void setSamplePayloadUrl(java.lang.String value)
```
    The Amazon Simple Storage Service path where the sample payload are stored.
    This path must point to a single gzip compressed tar archive (.tar.gz suffix).
  - getSourceAlgorithmSpecification
```
public java.lang.Object getSourceAlgorithmSpecification()
```
    A list of algorithms that were used to create a model package.
  - setSourceAlgorithmSpecification
```
public void setSourceAlgorithmSpecification(IResolvable value)
```
    A list of algorithms that were used to create a model package.
  - setSourceAlgorithmSpecification
```
public void setSourceAlgorithmSpecification(CfnModelPackage.SourceAlgorithmSpecificationProperty value)
```
    A list of algorithms that were used to create a model package.
  - getTask
```
public java.lang.String getTask()
```
    The machine learning task your model package accomplishes.
    Common machine learning tasks include object detection and image classification.
  - setTask
```
public void setTask(java.lang.String value)
```
    The machine learning task your model package accomplishes.
    Common machine learning tasks include object detection and image classification.
  - getValidationSpecification
```
public java.lang.Object getValidationSpecification()
```
    Specifies batch transform jobs that SageMaker runs to validate your model package.
  - setValidationSpecification
```
public void setValidationSpecification(IResolvable value)
```
    Specifies batch transform jobs that SageMaker runs to validate your model package.
  - setValidationSpecification
```
public void setValidationSpecification(CfnModelPackage.ValidationSpecificationProperty value)
```
    Specifies batch transform jobs that SageMaker runs to validate your model package.

Class CfnModelPackage

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnModelPackage

CfnModelPackage

CfnModelPackage

CfnModelPackage

Method Detail

inspect

renderProperties

getAttrCreationTime

getAttrModelPackageArn

getAttrModelPackageStatus

getCfnProperties

getTags

getAdditionalInferenceSpecificationDefinition

setAdditionalInferenceSpecificationDefinition

setAdditionalInferenceSpecificationDefinition

getAdditionalInferenceSpecifications

setAdditionalInferenceSpecifications

setAdditionalInferenceSpecifications

getAdditionalInferenceSpecificationsToAdd

setAdditionalInferenceSpecificationsToAdd

setAdditionalInferenceSpecificationsToAdd

getApprovalDescription

setApprovalDescription

getCertifyForMarketplace

setCertifyForMarketplace

setCertifyForMarketplace

getClientToken

setClientToken

getCreatedBy

setCreatedBy

setCreatedBy

getCustomerMetadataProperties

setCustomerMetadataProperties

setCustomerMetadataProperties

getDomain

setDomain

getDriftCheckBaselines

setDriftCheckBaselines

setDriftCheckBaselines

getEnvironment

setEnvironment

setEnvironment

getInferenceSpecification

setInferenceSpecification

setInferenceSpecification

getLastModifiedBy

setLastModifiedBy

setLastModifiedBy

getLastModifiedTime

setLastModifiedTime

getMetadataProperties

setMetadataProperties

setMetadataProperties

getModelApprovalStatus

setModelApprovalStatus

getModelMetrics

setModelMetrics

setModelMetrics

getModelPackageDescription

setModelPackageDescription

getModelPackageGroupName

setModelPackageGroupName

getModelPackageName

setModelPackageName

getModelPackageStatusDetails