software.amazon.awscdk.services.sagemaker

Class CfnModelPackage

java.lang.Object

software.amazon.jsii.JsiiObject

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:

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

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:55.830Z")
 @Stability(value=Stable)
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 environment;
 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(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(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(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(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(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 Example:
static interface	CfnModelPackage.ModelDataQualityProperty Data quality constraints and statistics for a 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 Example:
static interface	CfnModelPackage.ValidationProfileProperty Example:
static interface	CfnModelPackage.ValidationSpecificationProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnModelPackage(Construct scope, String id) Create a new `AWS::SageMaker::ModelPackage`.
	CfnModelPackage(Construct scope, 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

Modifier and Type	Method and Description
Object	getAdditionalInferenceSpecificationDefinition() `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.
Object	getAdditionalInferenceSpecifications() An array of additional Inference Specification objects.
Object	getAdditionalInferenceSpecificationsToAdd() `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.
String	getApprovalDescription() A description provided when the model approval is set.
String	getAttrCreationTime()
String	getAttrModelPackageArn()
String	getAttrModelPackageStatus()
Object	getCertifyForMarketplace() Whether the model package is to be certified to be listed on AWS Marketplace.
protected Map<String,Object>	getCfnProperties()
String	getClientToken() `AWS::SageMaker::ModelPackage.ClientToken`.
Object	getCreatedBy() `AWS::SageMaker::ModelPackage.CreatedBy`.
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	getEnvironment() The environment variables to set in the Docker container.
Object	getInferenceSpecification() `AWS::SageMaker::ModelPackage.InferenceSpecification`.
Object	getLastModifiedBy() `AWS::SageMaker::ModelPackage.LastModifiedBy`.
String	getLastModifiedTime() The last time the model package was modified.
Object	getMetadataProperties() `AWS::SageMaker::ModelPackage.MetadataProperties`.
String	getModelApprovalStatus() The approval status of the model.
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() `AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.
Object	getModelPackageStatusItem() `AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.
Number	getModelPackageVersion() The version number of a versioned model.
String	getSamplePayloadUrl() The Amazon Simple Storage Service path where the sample payload are stored.
Object	getSourceAlgorithmSpecification() `AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.
TagManager	getTags() A list of the tags associated with the model package.
String	getTask() The machine learning task your model package accomplishes.
Object	getValidationSpecification() `AWS::SageMaker::ModelPackage.ValidationSpecification`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalInferenceSpecificationDefinition(CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty value) `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.
void	setAdditionalInferenceSpecificationDefinition(IResolvable value) `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.
void	setAdditionalInferenceSpecifications(IResolvable value) An array of additional Inference Specification objects.
void	setAdditionalInferenceSpecifications(List<Object> value) An array of additional Inference Specification objects.
void	setAdditionalInferenceSpecificationsToAdd(IResolvable value) `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.
void	setAdditionalInferenceSpecificationsToAdd(List<Object> value) `AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.
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) `AWS::SageMaker::ModelPackage.ClientToken`.
void	setCreatedBy(CfnModelPackage.UserContextProperty value) `AWS::SageMaker::ModelPackage.CreatedBy`.
void	setCreatedBy(IResolvable value) `AWS::SageMaker::ModelPackage.CreatedBy`.
void	setCustomerMetadataProperties(IResolvable value) The metadata properties for the model package.
void	setCustomerMetadataProperties(Map<String,String> 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(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(Map<String,String> value) The environment variables to set in the Docker container.
void	setInferenceSpecification(CfnModelPackage.InferenceSpecificationProperty value) `AWS::SageMaker::ModelPackage.InferenceSpecification`.
void	setInferenceSpecification(IResolvable value) `AWS::SageMaker::ModelPackage.InferenceSpecification`.
void	setLastModifiedBy(CfnModelPackage.UserContextProperty value) `AWS::SageMaker::ModelPackage.LastModifiedBy`.
void	setLastModifiedBy(IResolvable value) `AWS::SageMaker::ModelPackage.LastModifiedBy`.
void	setLastModifiedTime(String value) The last time the model package was modified.
void	setMetadataProperties(CfnModelPackage.MetadataPropertiesProperty value) `AWS::SageMaker::ModelPackage.MetadataProperties`.
void	setMetadataProperties(IResolvable value) `AWS::SageMaker::ModelPackage.MetadataProperties`.
void	setModelApprovalStatus(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(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(CfnModelPackage.ModelPackageStatusDetailsProperty value) `AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.
void	setModelPackageStatusDetails(IResolvable value) `AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.
void	setModelPackageStatusItem(CfnModelPackage.ModelPackageStatusItemProperty value) `AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.
void	setModelPackageStatusItem(IResolvable value) `AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.
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	setSourceAlgorithmSpecification(CfnModelPackage.SourceAlgorithmSpecificationProperty value) `AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.
void	setSourceAlgorithmSpecification(IResolvable value) `AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.
void	setTask(String value) The machine learning task your model package accomplishes.
void	setValidationSpecification(CfnModelPackage.ValidationSpecificationProperty value) `AWS::SageMaker::ModelPackage.ValidationSpecification`.
void	setValidationSpecification(IResolvable value) `AWS::SageMaker::ModelPackage.ValidationSpecification`.

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 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnModelPackage(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @Nullable
                                                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

@Stability(value=Stable)
public CfnModelPackage(@NotNull
                                                Construct scope,
                                                @NotNull
                                                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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrCreationTime()

getAttrModelPackageArn

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

getAttrModelPackageStatus

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @Nullable
public Object getAdditionalInferenceSpecificationDefinition()

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.

setAdditionalInferenceSpecificationDefinition

@Stability(value=Stable)
public void setAdditionalInferenceSpecificationDefinition(@Nullable
                                                                                   CfnModelPackage.AdditionalInferenceSpecificationDefinitionProperty value)

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.

setAdditionalInferenceSpecificationDefinition

@Stability(value=Stable)
public void setAdditionalInferenceSpecificationDefinition(@Nullable
                                                                                   IResolvable value)

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition`.

getAdditionalInferenceSpecifications

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

An array of additional Inference Specification objects.

setAdditionalInferenceSpecifications

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

An array of additional Inference Specification objects.

setAdditionalInferenceSpecifications

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

An array of additional Inference Specification objects.

getAdditionalInferenceSpecificationsToAdd

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

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.

setAdditionalInferenceSpecificationsToAdd

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

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.

setAdditionalInferenceSpecificationsToAdd

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

`AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationsToAdd`.

getApprovalDescription

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

A description provided when the model approval is set.

setApprovalDescription

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

A description provided when the model approval is set.

getCertifyForMarketplace

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setCertifyForMarketplace(@Nullable
                                                              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

@Stability(value=Stable)
public void setCertifyForMarketplace(@Nullable
                                                              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

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

`AWS::SageMaker::ModelPackage.ClientToken`.

setClientToken

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

`AWS::SageMaker::ModelPackage.ClientToken`.

getCreatedBy

@Stability(value=Stable)
 @Nullable
public Object getCreatedBy()

`AWS::SageMaker::ModelPackage.CreatedBy`.

setCreatedBy

@Stability(value=Stable)
public void setCreatedBy(@Nullable
                                                  CfnModelPackage.UserContextProperty value)

`AWS::SageMaker::ModelPackage.CreatedBy`.

setCreatedBy

@Stability(value=Stable)
public void setCreatedBy(@Nullable
                                                  IResolvable value)

`AWS::SageMaker::ModelPackage.CreatedBy`.

getCustomerMetadataProperties

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

The metadata properties for the model package.

setCustomerMetadataProperties

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

The metadata properties for the model package.

setCustomerMetadataProperties

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

The metadata properties for the model package.

getDomain

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDomain(@Nullable
                                               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

@Stability(value=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(value=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.

setDriftCheckBaselines

@Stability(value=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.

getEnvironment

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    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

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    Map<String,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

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

`AWS::SageMaker::ModelPackage.InferenceSpecification`.

setInferenceSpecification

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

`AWS::SageMaker::ModelPackage.InferenceSpecification`.

setInferenceSpecification

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

`AWS::SageMaker::ModelPackage.InferenceSpecification`.

getLastModifiedBy

@Stability(value=Stable)
 @Nullable
public Object getLastModifiedBy()

`AWS::SageMaker::ModelPackage.LastModifiedBy`.

setLastModifiedBy

@Stability(value=Stable)
public void setLastModifiedBy(@Nullable
                                                       CfnModelPackage.UserContextProperty value)

`AWS::SageMaker::ModelPackage.LastModifiedBy`.

setLastModifiedBy

@Stability(value=Stable)
public void setLastModifiedBy(@Nullable
                                                       IResolvable value)

`AWS::SageMaker::ModelPackage.LastModifiedBy`.

getLastModifiedTime

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

The last time the model package was modified.

setLastModifiedTime

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

The last time the model package was modified.

getMetadataProperties

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

`AWS::SageMaker::ModelPackage.MetadataProperties`.

setMetadataProperties

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

`AWS::SageMaker::ModelPackage.MetadataProperties`.

setMetadataProperties

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

`AWS::SageMaker::ModelPackage.MetadataProperties`.

getModelApprovalStatus

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setModelApprovalStatus(@Nullable
                                                            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

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

Metrics for the model.

setModelMetrics

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

Metrics for the model.

setModelMetrics

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

Metrics for the model.

getModelPackageDescription

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

The description of the model package.

setModelPackageDescription

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

The description of the model package.

getModelPackageGroupName

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

The model group to which the model belongs.

setModelPackageGroupName

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

The model group to which the model belongs.

getModelPackageName

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

The name of the model.

setModelPackageName

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

The name of the model.

getModelPackageStatusDetails

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

`AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.

setModelPackageStatusDetails

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

`AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.

setModelPackageStatusDetails

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

`AWS::SageMaker::ModelPackage.ModelPackageStatusDetails`.

getModelPackageStatusItem

@Stability(value=Stable)
 @Nullable
public Object getModelPackageStatusItem()

`AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.

setModelPackageStatusItem

@Stability(value=Stable)
public void setModelPackageStatusItem(@Nullable
                                                               CfnModelPackage.ModelPackageStatusItemProperty value)

`AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.

setModelPackageStatusItem

@Stability(value=Stable)
public void setModelPackageStatusItem(@Nullable
                                                               IResolvable value)

`AWS::SageMaker::ModelPackage.ModelPackageStatusItem`.

getModelPackageVersion

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

The version number of a versioned model.

setModelPackageVersion

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

The version number of a versioned model.

getSamplePayloadUrl

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setSamplePayloadUrl(@Nullable
                                                         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

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

`AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.

setSourceAlgorithmSpecification

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

`AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.

setSourceAlgorithmSpecification

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

`AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification`.

getTask

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

The machine learning task your model package accomplishes.

Common machine learning tasks include object detection and image classification.

setTask

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

The machine learning task your model package accomplishes.

Common machine learning tasks include object detection and image classification.

getValidationSpecification

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

`AWS::SageMaker::ModelPackage.ValidationSpecification`.

setValidationSpecification

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

`AWS::SageMaker::ModelPackage.ValidationSpecification`.

setValidationSpecification

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

`AWS::SageMaker::ModelPackage.ValidationSpecification`.