Class CfnModelPackage.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnModelPackage>
- Enclosing class:
CfnModelPackage
CfnModelPackage
.-
Method Summary
Modifier and TypeMethodDescriptionadditionalInferenceSpecifications
(List<? extends Object> additionalInferenceSpecifications) An array of additional Inference Specification objects.additionalInferenceSpecifications
(IResolvable additionalInferenceSpecifications) An array of additional Inference Specification objects.additionalInferenceSpecificationsToAdd
(List<? extends Object> additionalInferenceSpecificationsToAdd) An array of additional Inference Specification objects to be added to the existing array.additionalInferenceSpecificationsToAdd
(IResolvable additionalInferenceSpecificationsToAdd) An array of additional Inference Specification objects to be added to the existing array.approvalDescription
(String approvalDescription) A description provided when the model approval is set.build()
certifyForMarketplace
(Boolean certifyForMarketplace) Whether the model package is to be certified to be listed on AWS Marketplace.certifyForMarketplace
(IResolvable certifyForMarketplace) Whether the model package is to be certified to be listed on AWS Marketplace.clientToken
(String clientToken) A unique token that guarantees that the call to this API is idempotent.static CfnModelPackage.Builder
customerMetadataProperties
(Map<String, String> customerMetadataProperties) The metadata properties for the model package.customerMetadataProperties
(IResolvable customerMetadataProperties) The metadata properties for the model package.The machine learning domain of your model package and its components.driftCheckBaselines
(IResolvable driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.driftCheckBaselines
(CfnModelPackage.DriftCheckBaselinesProperty driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.inferenceSpecification
(IResolvable inferenceSpecification) Defines how to perform inference generation after a training job is run.inferenceSpecification
(CfnModelPackage.InferenceSpecificationProperty inferenceSpecification) Defines how to perform inference generation after a training job is run.lastModifiedTime
(String lastModifiedTime) The last time the model package was modified.metadataProperties
(IResolvable metadataProperties) Metadata properties of the tracking entity, trial, or trial component.metadataProperties
(CfnModelPackage.MetadataPropertiesProperty metadataProperties) Metadata properties of the tracking entity, trial, or trial component.modelApprovalStatus
(String modelApprovalStatus) The approval status of the model.modelCard
(IResolvable modelCard) An Amazon SageMaker Model Card.modelCard
(CfnModelPackage.ModelCardProperty modelCard) An Amazon SageMaker Model Card.modelMetrics
(IResolvable modelMetrics) Metrics for the model.modelMetrics
(CfnModelPackage.ModelMetricsProperty modelMetrics) Metrics for the model.modelPackageDescription
(String modelPackageDescription) The description of the model package.modelPackageGroupName
(String modelPackageGroupName) The model group to which the model belongs.modelPackageName
(String modelPackageName) The name of the model.modelPackageStatusDetails
(IResolvable modelPackageStatusDetails) Specifies the validation and image scan statuses of the model package.modelPackageStatusDetails
(CfnModelPackage.ModelPackageStatusDetailsProperty modelPackageStatusDetails) Specifies the validation and image scan statuses of the model package.modelPackageVersion
(Number modelPackageVersion) The version number of a versioned model.samplePayloadUrl
(String samplePayloadUrl) The Amazon Simple Storage Service path where the sample payload are stored.securityConfig
(IResolvable securityConfig) An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.securityConfig
(CfnModelPackage.SecurityConfigProperty securityConfig) An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.skipModelValidation
(String skipModelValidation) Indicates if you want to skip model validation.sourceAlgorithmSpecification
(IResolvable sourceAlgorithmSpecification) A list of algorithms that were used to create a model package.sourceAlgorithmSpecification
(CfnModelPackage.SourceAlgorithmSpecificationProperty sourceAlgorithmSpecification) A list of algorithms that were used to create a model package.The URI of the source for the model package.A list of the tags associated with the model package.The machine learning task your model package accomplishes.validationSpecification
(IResolvable validationSpecification) Specifies batch transform jobs that SageMaker runs to validate your model package.validationSpecification
(CfnModelPackage.ValidationSpecificationProperty validationSpecification) Specifies batch transform jobs that SageMaker runs to validate your model package.
-
Method Details
-
create
@Stability(Stable) public static CfnModelPackage.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnModelPackage.Builder
.
-
additionalInferenceSpecifications
@Stability(Stable) public CfnModelPackage.Builder additionalInferenceSpecifications(IResolvable additionalInferenceSpecifications) An array of additional Inference Specification objects.- Parameters:
additionalInferenceSpecifications
- An array of additional Inference Specification objects. This parameter is required.- Returns:
this
- See Also:
-
additionalInferenceSpecifications
@Stability(Stable) public CfnModelPackage.Builder additionalInferenceSpecifications(List<? extends Object> additionalInferenceSpecifications) An array of additional Inference Specification objects.- Parameters:
additionalInferenceSpecifications
- An array of additional Inference Specification objects. This parameter is required.- Returns:
this
- See Also:
-
additionalInferenceSpecificationsToAdd
@Stability(Stable) public CfnModelPackage.Builder additionalInferenceSpecificationsToAdd(IResolvable additionalInferenceSpecificationsToAdd) 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.
- Parameters:
additionalInferenceSpecificationsToAdd
- An array of additional Inference Specification objects to be added to the existing array. This parameter is required.- Returns:
this
- See Also:
-
additionalInferenceSpecificationsToAdd
@Stability(Stable) public CfnModelPackage.Builder additionalInferenceSpecificationsToAdd(List<? extends Object> additionalInferenceSpecificationsToAdd) 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.
- Parameters:
additionalInferenceSpecificationsToAdd
- An array of additional Inference Specification objects to be added to the existing array. This parameter is required.- Returns:
this
- See Also:
-
approvalDescription
A description provided when the model approval is set.- Parameters:
approvalDescription
- A description provided when the model approval is set. This parameter is required.- Returns:
this
- See Also:
-
certifyForMarketplace
@Stability(Stable) public CfnModelPackage.Builder certifyForMarketplace(Boolean certifyForMarketplace) 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 .
- Parameters:
certifyForMarketplace
- Whether the model package is to be certified to be listed on AWS Marketplace. This parameter is required.- Returns:
this
- See Also:
-
certifyForMarketplace
@Stability(Stable) public CfnModelPackage.Builder certifyForMarketplace(IResolvable certifyForMarketplace) 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 .
- Parameters:
certifyForMarketplace
- Whether the model package is to be certified to be listed on AWS Marketplace. This parameter is required.- Returns:
this
- See Also:
-
clientToken
A unique token that guarantees that the call to this API is idempotent.- Parameters:
clientToken
- A unique token that guarantees that the call to this API is idempotent. This parameter is required.- Returns:
this
- See Also:
-
customerMetadataProperties
@Stability(Stable) public CfnModelPackage.Builder customerMetadataProperties(IResolvable customerMetadataProperties) The metadata properties for the model package.- Parameters:
customerMetadataProperties
- The metadata properties for the model package. This parameter is required.- Returns:
this
- See Also:
-
customerMetadataProperties
@Stability(Stable) public CfnModelPackage.Builder customerMetadataProperties(Map<String, String> customerMetadataProperties) The metadata properties for the model package.- Parameters:
customerMetadataProperties
- The metadata properties for the model package. This parameter is required.- Returns:
this
- See Also:
-
domain
The machine learning domain of your model package and its components.Common machine learning domains include computer vision and natural language processing.
- Parameters:
domain
- The machine learning domain of your model package and its components. This parameter is required.- Returns:
this
- See Also:
-
driftCheckBaselines
@Stability(Stable) public CfnModelPackage.Builder driftCheckBaselines(IResolvable driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.- Parameters:
driftCheckBaselines
- Represents the drift check baselines that can be used when the model monitor is set using the model package. This parameter is required.- Returns:
this
- See Also:
-
driftCheckBaselines
@Stability(Stable) public CfnModelPackage.Builder driftCheckBaselines(CfnModelPackage.DriftCheckBaselinesProperty driftCheckBaselines) Represents the drift check baselines that can be used when the model monitor is set using the model package.- Parameters:
driftCheckBaselines
- Represents the drift check baselines that can be used when the model monitor is set using the model package. This parameter is required.- Returns:
this
- See Also:
-
inferenceSpecification
@Stability(Stable) public CfnModelPackage.Builder inferenceSpecification(IResolvable inferenceSpecification) Defines how to perform inference generation after a training job is run.- Parameters:
inferenceSpecification
- Defines how to perform inference generation after a training job is run. This parameter is required.- Returns:
this
- See Also:
-
inferenceSpecification
@Stability(Stable) public CfnModelPackage.Builder inferenceSpecification(CfnModelPackage.InferenceSpecificationProperty inferenceSpecification) Defines how to perform inference generation after a training job is run.- Parameters:
inferenceSpecification
- Defines how to perform inference generation after a training job is run. This parameter is required.- Returns:
this
- See Also:
-
lastModifiedTime
The last time the model package was modified.- Parameters:
lastModifiedTime
- The last time the model package was modified. This parameter is required.- Returns:
this
- See Also:
-
metadataProperties
@Stability(Stable) public CfnModelPackage.Builder metadataProperties(IResolvable metadataProperties) Metadata properties of the tracking entity, trial, or trial component.- Parameters:
metadataProperties
- Metadata properties of the tracking entity, trial, or trial component. This parameter is required.- Returns:
this
- See Also:
-
metadataProperties
@Stability(Stable) public CfnModelPackage.Builder metadataProperties(CfnModelPackage.MetadataPropertiesProperty metadataProperties) Metadata properties of the tracking entity, trial, or trial component.- Parameters:
metadataProperties
- Metadata properties of the tracking entity, trial, or trial component. This parameter is required.- Returns:
this
- See Also:
-
modelApprovalStatus
The approval status of the model. This can be one of the following values.APPROVED
- The model is approvedREJECTED
- The model is rejected.PENDING_MANUAL_APPROVAL
- The model is waiting for manual approval.
- Parameters:
modelApprovalStatus
- The approval status of the model. This can be one of the following values. This parameter is required.- Returns:
this
- See Also:
-
modelCard
An Amazon SageMaker Model Card.- Parameters:
modelCard
- An Amazon SageMaker Model Card. This parameter is required.- Returns:
this
- See Also:
-
modelCard
@Stability(Stable) public CfnModelPackage.Builder modelCard(CfnModelPackage.ModelCardProperty modelCard) An Amazon SageMaker Model Card.- Parameters:
modelCard
- An Amazon SageMaker Model Card. This parameter is required.- Returns:
this
- See Also:
-
modelMetrics
Metrics for the model.- Parameters:
modelMetrics
- Metrics for the model. This parameter is required.- Returns:
this
- See Also:
-
modelMetrics
@Stability(Stable) public CfnModelPackage.Builder modelMetrics(CfnModelPackage.ModelMetricsProperty modelMetrics) Metrics for the model.- Parameters:
modelMetrics
- Metrics for the model. This parameter is required.- Returns:
this
- See Also:
-
modelPackageDescription
@Stability(Stable) public CfnModelPackage.Builder modelPackageDescription(String modelPackageDescription) The description of the model package.- Parameters:
modelPackageDescription
- The description of the model package. This parameter is required.- Returns:
this
- See Also:
-
modelPackageGroupName
@Stability(Stable) public CfnModelPackage.Builder modelPackageGroupName(String modelPackageGroupName) The model group to which the model belongs.- Parameters:
modelPackageGroupName
- The model group to which the model belongs. This parameter is required.- Returns:
this
- See Also:
-
modelPackageName
The name of the model.- Parameters:
modelPackageName
- The name of the model. This parameter is required.- Returns:
this
- See Also:
-
modelPackageStatusDetails
@Stability(Stable) public CfnModelPackage.Builder modelPackageStatusDetails(IResolvable modelPackageStatusDetails) Specifies the validation and image scan statuses of the model package.- Parameters:
modelPackageStatusDetails
- Specifies the validation and image scan statuses of the model package. This parameter is required.- Returns:
this
- See Also:
-
modelPackageStatusDetails
@Stability(Stable) public CfnModelPackage.Builder modelPackageStatusDetails(CfnModelPackage.ModelPackageStatusDetailsProperty modelPackageStatusDetails) Specifies the validation and image scan statuses of the model package.- Parameters:
modelPackageStatusDetails
- Specifies the validation and image scan statuses of the model package. This parameter is required.- Returns:
this
- See Also:
-
modelPackageVersion
The version number of a versioned model.- Parameters:
modelPackageVersion
- The version number of a versioned model. This parameter is required.- Returns:
this
- See Also:
-
samplePayloadUrl
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).
- Parameters:
samplePayloadUrl
- The Amazon Simple Storage Service path where the sample payload are stored. This parameter is required.- Returns:
this
- See Also:
-
securityConfig
An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.- Parameters:
securityConfig
- An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data. This parameter is required.- Returns:
this
- See Also:
-
securityConfig
@Stability(Stable) public CfnModelPackage.Builder securityConfig(CfnModelPackage.SecurityConfigProperty securityConfig) An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.- Parameters:
securityConfig
- An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data. This parameter is required.- Returns:
this
- See Also:
-
skipModelValidation
Indicates if you want to skip model validation.- Parameters:
skipModelValidation
- Indicates if you want to skip model validation. This parameter is required.- Returns:
this
- See Also:
-
sourceAlgorithmSpecification
@Stability(Stable) public CfnModelPackage.Builder sourceAlgorithmSpecification(IResolvable sourceAlgorithmSpecification) A list of algorithms that were used to create a model package.- Parameters:
sourceAlgorithmSpecification
- A list of algorithms that were used to create a model package. This parameter is required.- Returns:
this
- See Also:
-
sourceAlgorithmSpecification
@Stability(Stable) public CfnModelPackage.Builder sourceAlgorithmSpecification(CfnModelPackage.SourceAlgorithmSpecificationProperty sourceAlgorithmSpecification) A list of algorithms that were used to create a model package.- Parameters:
sourceAlgorithmSpecification
- A list of algorithms that were used to create a model package. This parameter is required.- Returns:
this
- See Also:
-
sourceUri
The URI of the source for the model package.- Parameters:
sourceUri
- The URI of the source for the model package. This parameter is required.- Returns:
this
- See Also:
-
tags
A list of the tags associated with the model package.For more information, see Tagging AWS resources in the AWS General Reference Guide .
- Parameters:
tags
- A list of the tags associated with the model package. This parameter is required.- Returns:
this
- See Also:
-
task
The machine learning task your model package accomplishes.Common machine learning tasks include object detection and image classification.
- Parameters:
task
- The machine learning task your model package accomplishes. This parameter is required.- Returns:
this
- See Also:
-
validationSpecification
@Stability(Stable) public CfnModelPackage.Builder validationSpecification(IResolvable validationSpecification) Specifies batch transform jobs that SageMaker runs to validate your model package.- Parameters:
validationSpecification
- Specifies batch transform jobs that SageMaker runs to validate your model package. This parameter is required.- Returns:
this
- See Also:
-
validationSpecification
@Stability(Stable) public CfnModelPackage.Builder validationSpecification(CfnModelPackage.ValidationSpecificationProperty validationSpecification) Specifies batch transform jobs that SageMaker runs to validate your model package.- Parameters:
validationSpecification
- Specifies batch transform jobs that SageMaker runs to validate your model package. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnModelPackage>
- Returns:
- a newly built instance of
CfnModelPackage
.
-