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

Class CfnModelPackageMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnModelPackageMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnModelPackageMixinProps>

Enclosing interface:

CfnModelPackageMixinProps

@Stability(Stable)
public static final class CfnModelPackageMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnModelPackageMixinProps>

A builder for CfnModelPackageMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnModelPackageMixinProps.Builder	additionalInferenceSpecifications(List<? extends Object> additionalInferenceSpecifications)	Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecifications()
CfnModelPackageMixinProps.Builder	additionalInferenceSpecifications(IResolvable additionalInferenceSpecifications)	Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecifications()
CfnModelPackageMixinProps.Builder	additionalInferenceSpecificationsToAdd(List<? extends Object> additionalInferenceSpecificationsToAdd)	Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecificationsToAdd()
CfnModelPackageMixinProps.Builder	additionalInferenceSpecificationsToAdd(IResolvable additionalInferenceSpecificationsToAdd)	Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecificationsToAdd()
CfnModelPackageMixinProps.Builder	approvalDescription(String approvalDescription)	Sets the value of CfnModelPackageMixinProps.getApprovalDescription()
CfnModelPackageMixinProps	build()	Builds the configured instance.
CfnModelPackageMixinProps.Builder	certifyForMarketplace(Boolean certifyForMarketplace)	Sets the value of CfnModelPackageMixinProps.getCertifyForMarketplace()
CfnModelPackageMixinProps.Builder	certifyForMarketplace(IResolvable certifyForMarketplace)	Sets the value of CfnModelPackageMixinProps.getCertifyForMarketplace()
CfnModelPackageMixinProps.Builder	clientToken(String clientToken)	Sets the value of CfnModelPackageMixinProps.getClientToken()
CfnModelPackageMixinProps.Builder	customerMetadataProperties(Map<String,String> customerMetadataProperties)	Sets the value of CfnModelPackageMixinProps.getCustomerMetadataProperties()
CfnModelPackageMixinProps.Builder	customerMetadataProperties(IResolvable customerMetadataProperties)	Sets the value of CfnModelPackageMixinProps.getCustomerMetadataProperties()
CfnModelPackageMixinProps.Builder	domain(String domain)	Sets the value of CfnModelPackageMixinProps.getDomain()
CfnModelPackageMixinProps.Builder	driftCheckBaselines(CfnModelPackagePropsMixin.DriftCheckBaselinesProperty driftCheckBaselines)	Sets the value of CfnModelPackageMixinProps.getDriftCheckBaselines()
CfnModelPackageMixinProps.Builder	driftCheckBaselines(IResolvable driftCheckBaselines)	Sets the value of CfnModelPackageMixinProps.getDriftCheckBaselines()
CfnModelPackageMixinProps.Builder	inferenceSpecification(CfnModelPackagePropsMixin.InferenceSpecificationProperty inferenceSpecification)	Sets the value of CfnModelPackageMixinProps.getInferenceSpecification()
CfnModelPackageMixinProps.Builder	inferenceSpecification(IResolvable inferenceSpecification)	Sets the value of CfnModelPackageMixinProps.getInferenceSpecification()
CfnModelPackageMixinProps.Builder	lastModifiedTime(String lastModifiedTime)	Sets the value of CfnModelPackageMixinProps.getLastModifiedTime()
CfnModelPackageMixinProps.Builder	metadataProperties(CfnModelPackagePropsMixin.MetadataPropertiesProperty metadataProperties)	Sets the value of CfnModelPackageMixinProps.getMetadataProperties()
CfnModelPackageMixinProps.Builder	metadataProperties(IResolvable metadataProperties)	Sets the value of CfnModelPackageMixinProps.getMetadataProperties()
CfnModelPackageMixinProps.Builder	modelApprovalStatus(String modelApprovalStatus)	Sets the value of CfnModelPackageMixinProps.getModelApprovalStatus()
CfnModelPackageMixinProps.Builder	modelCard(CfnModelPackagePropsMixin.ModelCardProperty modelCard)	Sets the value of CfnModelPackageMixinProps.getModelCard()
CfnModelPackageMixinProps.Builder	modelCard(IResolvable modelCard)	Sets the value of CfnModelPackageMixinProps.getModelCard()
CfnModelPackageMixinProps.Builder	modelMetrics(CfnModelPackagePropsMixin.ModelMetricsProperty modelMetrics)	Sets the value of CfnModelPackageMixinProps.getModelMetrics()
CfnModelPackageMixinProps.Builder	modelMetrics(IResolvable modelMetrics)	Sets the value of CfnModelPackageMixinProps.getModelMetrics()
CfnModelPackageMixinProps.Builder	modelPackageDescription(String modelPackageDescription)	Sets the value of CfnModelPackageMixinProps.getModelPackageDescription()
CfnModelPackageMixinProps.Builder	modelPackageGroupName(String modelPackageGroupName)	Sets the value of CfnModelPackageMixinProps.getModelPackageGroupName()
CfnModelPackageMixinProps.Builder	modelPackageName(String modelPackageName)	Sets the value of CfnModelPackageMixinProps.getModelPackageName()
CfnModelPackageMixinProps.Builder	modelPackageStatusDetails(CfnModelPackagePropsMixin.ModelPackageStatusDetailsProperty modelPackageStatusDetails)	Sets the value of CfnModelPackageMixinProps.getModelPackageStatusDetails()
CfnModelPackageMixinProps.Builder	modelPackageStatusDetails(IResolvable modelPackageStatusDetails)	Sets the value of CfnModelPackageMixinProps.getModelPackageStatusDetails()
CfnModelPackageMixinProps.Builder	modelPackageVersion(Number modelPackageVersion)	Sets the value of CfnModelPackageMixinProps.getModelPackageVersion()
CfnModelPackageMixinProps.Builder	samplePayloadUrl(String samplePayloadUrl)	Sets the value of CfnModelPackageMixinProps.getSamplePayloadUrl()
CfnModelPackageMixinProps.Builder	securityConfig(CfnModelPackagePropsMixin.SecurityConfigProperty securityConfig)	Sets the value of CfnModelPackageMixinProps.getSecurityConfig()
CfnModelPackageMixinProps.Builder	securityConfig(IResolvable securityConfig)	Sets the value of CfnModelPackageMixinProps.getSecurityConfig()
CfnModelPackageMixinProps.Builder	skipModelValidation(String skipModelValidation)	Sets the value of CfnModelPackageMixinProps.getSkipModelValidation()
CfnModelPackageMixinProps.Builder	sourceAlgorithmSpecification(CfnModelPackagePropsMixin.SourceAlgorithmSpecificationProperty sourceAlgorithmSpecification)	Sets the value of CfnModelPackageMixinProps.getSourceAlgorithmSpecification()
CfnModelPackageMixinProps.Builder	sourceAlgorithmSpecification(IResolvable sourceAlgorithmSpecification)	Sets the value of CfnModelPackageMixinProps.getSourceAlgorithmSpecification()
CfnModelPackageMixinProps.Builder	sourceUri(String sourceUri)	Sets the value of CfnModelPackageMixinProps.getSourceUri()
CfnModelPackageMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnModelPackageMixinProps.getTags()
CfnModelPackageMixinProps.Builder	task(String task)	Sets the value of CfnModelPackageMixinProps.getTask()
CfnModelPackageMixinProps.Builder	validationSpecification(CfnModelPackagePropsMixin.ValidationSpecificationProperty validationSpecification)	Sets the value of CfnModelPackageMixinProps.getValidationSpecification()
CfnModelPackageMixinProps.Builder	validationSpecification(IResolvable validationSpecification)	Sets the value of CfnModelPackageMixinProps.getValidationSpecification()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

additionalInferenceSpecifications

@Stability(Stable)
public CfnModelPackageMixinProps.Builder additionalInferenceSpecifications(IResolvable additionalInferenceSpecifications)

Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecifications()

Parameters:

additionalInferenceSpecifications - An array of additional Inference Specification objects.

Returns:

this

additionalInferenceSpecifications

@Stability(Stable)
public CfnModelPackageMixinProps.Builder additionalInferenceSpecifications(List<? extends Object> additionalInferenceSpecifications)

Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecifications()

Parameters:

additionalInferenceSpecifications - An array of additional Inference Specification objects.

Returns:

this

additionalInferenceSpecificationsToAdd

@Stability(Stable)
public CfnModelPackageMixinProps.Builder additionalInferenceSpecificationsToAdd(IResolvable additionalInferenceSpecificationsToAdd)

Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecificationsToAdd()

Parameters:

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.

Returns:

this

additionalInferenceSpecificationsToAdd

@Stability(Stable)
public CfnModelPackageMixinProps.Builder additionalInferenceSpecificationsToAdd(List<? extends Object> additionalInferenceSpecificationsToAdd)

Sets the value of CfnModelPackageMixinProps.getAdditionalInferenceSpecificationsToAdd()

Parameters:

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.

Returns:

this

approvalDescription

@Stability(Stable)
public CfnModelPackageMixinProps.Builder approvalDescription(String approvalDescription)

Sets the value of CfnModelPackageMixinProps.getApprovalDescription()

Parameters:

approvalDescription - A description provided when the model approval is set.

Returns:

this

certifyForMarketplace

@Stability(Stable)
public CfnModelPackageMixinProps.Builder certifyForMarketplace(Boolean certifyForMarketplace)

Sets the value of CfnModelPackageMixinProps.getCertifyForMarketplace()

Parameters:

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 .

Returns:

this

certifyForMarketplace

@Stability(Stable)
public CfnModelPackageMixinProps.Builder certifyForMarketplace(IResolvable certifyForMarketplace)

Sets the value of CfnModelPackageMixinProps.getCertifyForMarketplace()

Parameters:

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 .

Returns:

this

clientToken

@Stability(Stable)
public CfnModelPackageMixinProps.Builder clientToken(String clientToken)

Sets the value of CfnModelPackageMixinProps.getClientToken()

Parameters:

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

Returns:

this

customerMetadataProperties

@Stability(Stable)
public CfnModelPackageMixinProps.Builder customerMetadataProperties(Map<String,String> customerMetadataProperties)

Sets the value of CfnModelPackageMixinProps.getCustomerMetadataProperties()

Parameters:

customerMetadataProperties - The metadata properties for the model package.

Returns:

this

customerMetadataProperties

@Stability(Stable)
public CfnModelPackageMixinProps.Builder customerMetadataProperties(IResolvable customerMetadataProperties)

Sets the value of CfnModelPackageMixinProps.getCustomerMetadataProperties()

Parameters:

customerMetadataProperties - The metadata properties for the model package.

Returns:

this

domain

@Stability(Stable)
public CfnModelPackageMixinProps.Builder domain(String domain)

Sets the value of CfnModelPackageMixinProps.getDomain()

Parameters:

domain - The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Returns:

this

driftCheckBaselines

@Stability(Stable)
public CfnModelPackageMixinProps.Builder driftCheckBaselines(IResolvable driftCheckBaselines)

Sets the value of CfnModelPackageMixinProps.getDriftCheckBaselines()

Parameters:

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

Returns:

this

driftCheckBaselines

@Stability(Stable)
public CfnModelPackageMixinProps.Builder driftCheckBaselines(CfnModelPackagePropsMixin.DriftCheckBaselinesProperty driftCheckBaselines)

Sets the value of CfnModelPackageMixinProps.getDriftCheckBaselines()

Parameters:

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

Returns:

this

inferenceSpecification

@Stability(Stable)
public CfnModelPackageMixinProps.Builder inferenceSpecification(IResolvable inferenceSpecification)

Sets the value of CfnModelPackageMixinProps.getInferenceSpecification()

Parameters:

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

Returns:

this

inferenceSpecification

@Stability(Stable)
public CfnModelPackageMixinProps.Builder inferenceSpecification(CfnModelPackagePropsMixin.InferenceSpecificationProperty inferenceSpecification)

Sets the value of CfnModelPackageMixinProps.getInferenceSpecification()

Parameters:

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

Returns:

this

lastModifiedTime

@Stability(Stable)
public CfnModelPackageMixinProps.Builder lastModifiedTime(String lastModifiedTime)

Sets the value of CfnModelPackageMixinProps.getLastModifiedTime()

Parameters:

lastModifiedTime - The last time the model package was modified.

Returns:

this

metadataProperties

@Stability(Stable)
public CfnModelPackageMixinProps.Builder metadataProperties(IResolvable metadataProperties)

Sets the value of CfnModelPackageMixinProps.getMetadataProperties()

Parameters:

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

Returns:

this

metadataProperties

@Stability(Stable)
public CfnModelPackageMixinProps.Builder metadataProperties(CfnModelPackagePropsMixin.MetadataPropertiesProperty metadataProperties)

Sets the value of CfnModelPackageMixinProps.getMetadataProperties()

Parameters:

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

Returns:

this

modelApprovalStatus

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelApprovalStatus(String modelApprovalStatus)

Sets the value of CfnModelPackageMixinProps.getModelApprovalStatus()

Parameters:

modelApprovalStatus - 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.

Returns:

this

modelCard

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelCard(IResolvable modelCard)

Sets the value of CfnModelPackageMixinProps.getModelCard()

Parameters:

modelCard - An Amazon SageMaker Model Card.

Returns:

this

modelCard

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelCard(CfnModelPackagePropsMixin.ModelCardProperty modelCard)

Sets the value of CfnModelPackageMixinProps.getModelCard()

Parameters:

modelCard - An Amazon SageMaker Model Card.

Returns:

this

modelMetrics

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelMetrics(IResolvable modelMetrics)

Sets the value of CfnModelPackageMixinProps.getModelMetrics()

Parameters:

modelMetrics - Metrics for the model.

Returns:

this

modelMetrics

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelMetrics(CfnModelPackagePropsMixin.ModelMetricsProperty modelMetrics)

Sets the value of CfnModelPackageMixinProps.getModelMetrics()

Parameters:

modelMetrics - Metrics for the model.

Returns:

this

modelPackageDescription

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelPackageDescription(String modelPackageDescription)

Sets the value of CfnModelPackageMixinProps.getModelPackageDescription()

Parameters:

modelPackageDescription - The description of the model package.

Returns:

this

modelPackageGroupName

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelPackageGroupName(String modelPackageGroupName)

Sets the value of CfnModelPackageMixinProps.getModelPackageGroupName()

Parameters:

modelPackageGroupName - The model group to which the model belongs.

Returns:

this

modelPackageName

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelPackageName(String modelPackageName)

Sets the value of CfnModelPackageMixinProps.getModelPackageName()

Parameters:

modelPackageName - The name of the model package. The name can be as follows:.

• For a versioned model, the name is automatically generated by SageMaker Model Registry and follows the format ' ModelPackageGroupName/ModelPackageVersion '.
• For an unversioned model, you must provide the name.

Returns:

this

modelPackageStatusDetails

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelPackageStatusDetails(IResolvable modelPackageStatusDetails)

Sets the value of CfnModelPackageMixinProps.getModelPackageStatusDetails()

Parameters:

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

Returns:

this

modelPackageStatusDetails

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelPackageStatusDetails(CfnModelPackagePropsMixin.ModelPackageStatusDetailsProperty modelPackageStatusDetails)

Sets the value of CfnModelPackageMixinProps.getModelPackageStatusDetails()

Parameters:

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

Returns:

this

modelPackageVersion

@Stability(Stable)
public CfnModelPackageMixinProps.Builder modelPackageVersion(Number modelPackageVersion)

Sets the value of CfnModelPackageMixinProps.getModelPackageVersion()

Parameters:

modelPackageVersion - The version number of a versioned model.

Returns:

this

samplePayloadUrl

@Stability(Stable)
public CfnModelPackageMixinProps.Builder samplePayloadUrl(String samplePayloadUrl)

Sets the value of CfnModelPackageMixinProps.getSamplePayloadUrl()

Parameters:

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).

Returns:

this

securityConfig

@Stability(Stable)
public CfnModelPackageMixinProps.Builder securityConfig(IResolvable securityConfig)

Sets the value of CfnModelPackageMixinProps.getSecurityConfig()

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.

Returns:

this

securityConfig

@Stability(Stable)
public CfnModelPackageMixinProps.Builder securityConfig(CfnModelPackagePropsMixin.SecurityConfigProperty securityConfig)

Sets the value of CfnModelPackageMixinProps.getSecurityConfig()

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.

Returns:

this

skipModelValidation

@Stability(Stable)
public CfnModelPackageMixinProps.Builder skipModelValidation(String skipModelValidation)

Sets the value of CfnModelPackageMixinProps.getSkipModelValidation()

Parameters:

skipModelValidation - Indicates if you want to skip model validation.

Returns:

this

sourceAlgorithmSpecification

@Stability(Stable)
public CfnModelPackageMixinProps.Builder sourceAlgorithmSpecification(IResolvable sourceAlgorithmSpecification)

Sets the value of CfnModelPackageMixinProps.getSourceAlgorithmSpecification()

Parameters:

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

Returns:

this

sourceAlgorithmSpecification

@Stability(Stable)
public CfnModelPackageMixinProps.Builder sourceAlgorithmSpecification(CfnModelPackagePropsMixin.SourceAlgorithmSpecificationProperty sourceAlgorithmSpecification)

Sets the value of CfnModelPackageMixinProps.getSourceAlgorithmSpecification()

Parameters:

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

Returns:

this

sourceUri

@Stability(Stable)
public CfnModelPackageMixinProps.Builder sourceUri(String sourceUri)

Sets the value of CfnModelPackageMixinProps.getSourceUri()

Parameters:

sourceUri - The URI of the source for the model package.

Returns:

this

tags

@Stability(Stable)
public CfnModelPackageMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnModelPackageMixinProps.getTags()

Parameters:

tags - A list of the tags associated with the model package. For more information, see Tagging AWS resources in the AWS General Reference Guide .

Returns:

this

task

@Stability(Stable)
public CfnModelPackageMixinProps.Builder task(String task)

Sets the value of CfnModelPackageMixinProps.getTask()

Parameters:

task - The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Returns:

this

validationSpecification

@Stability(Stable)
public CfnModelPackageMixinProps.Builder validationSpecification(IResolvable validationSpecification)

Sets the value of CfnModelPackageMixinProps.getValidationSpecification()

Parameters:

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

Returns:

this

validationSpecification

@Stability(Stable)
public CfnModelPackageMixinProps.Builder validationSpecification(CfnModelPackagePropsMixin.ValidationSpecificationProperty validationSpecification)

Sets the value of CfnModelPackageMixinProps.getValidationSpecification()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnModelPackageMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnModelPackageMixinProps>

Returns:

a new instance of CfnModelPackageMixinProps

Throws:

NullPointerException - if any required attribute was not provided