Package software.amazon.awscdk.services.sagemaker

Class CfnInferenceExperimentProps.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnInferenceExperimentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInferenceExperimentProps>

Enclosing interface:

CfnInferenceExperimentProps

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

A builder for CfnInferenceExperimentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnInferenceExperimentProps	build()	Builds the configured instance.
CfnInferenceExperimentProps.Builder	dataStorageConfig(IResolvable dataStorageConfig)	Sets the value of CfnInferenceExperimentProps.getDataStorageConfig()
CfnInferenceExperimentProps.Builder	dataStorageConfig(CfnInferenceExperiment.DataStorageConfigProperty dataStorageConfig)	Sets the value of CfnInferenceExperimentProps.getDataStorageConfig()
CfnInferenceExperimentProps.Builder	description(String description)	Sets the value of CfnInferenceExperimentProps.getDescription()
CfnInferenceExperimentProps.Builder	desiredState(String desiredState)	Sets the value of CfnInferenceExperimentProps.getDesiredState()
CfnInferenceExperimentProps.Builder	endpointName(String endpointName)	Sets the value of CfnInferenceExperimentProps.getEndpointName()
CfnInferenceExperimentProps.Builder	kmsKey(String kmsKey)	Sets the value of CfnInferenceExperimentProps.getKmsKey()
CfnInferenceExperimentProps.Builder	modelVariants(List<? extends Object> modelVariants)	Sets the value of CfnInferenceExperimentProps.getModelVariants()
CfnInferenceExperimentProps.Builder	modelVariants(IResolvable modelVariants)	Sets the value of CfnInferenceExperimentProps.getModelVariants()
CfnInferenceExperimentProps.Builder	name(String name)	Sets the value of CfnInferenceExperimentProps.getName()
CfnInferenceExperimentProps.Builder	roleArn(String roleArn)	Sets the value of CfnInferenceExperimentProps.getRoleArn()
CfnInferenceExperimentProps.Builder	schedule(IResolvable schedule)	Sets the value of CfnInferenceExperimentProps.getSchedule()
CfnInferenceExperimentProps.Builder	schedule(CfnInferenceExperiment.InferenceExperimentScheduleProperty schedule)	Sets the value of CfnInferenceExperimentProps.getSchedule()
CfnInferenceExperimentProps.Builder	shadowModeConfig(IResolvable shadowModeConfig)	Sets the value of CfnInferenceExperimentProps.getShadowModeConfig()
CfnInferenceExperimentProps.Builder	shadowModeConfig(CfnInferenceExperiment.ShadowModeConfigProperty shadowModeConfig)	Sets the value of CfnInferenceExperimentProps.getShadowModeConfig()
CfnInferenceExperimentProps.Builder	statusReason(String statusReason)	Sets the value of CfnInferenceExperimentProps.getStatusReason()
CfnInferenceExperimentProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnInferenceExperimentProps.getTags()
CfnInferenceExperimentProps.Builder	type(String type)	Sets the value of CfnInferenceExperimentProps.getType()

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

endpointName

@Stability(Stable)
public CfnInferenceExperimentProps.Builder endpointName(String endpointName)

Sets the value of CfnInferenceExperimentProps.getEndpointName()

Parameters:

endpointName - The name of the endpoint. This parameter is required.

Returns:

this

modelVariants

@Stability(Stable)
public CfnInferenceExperimentProps.Builder modelVariants(IResolvable modelVariants)

Sets the value of CfnInferenceExperimentProps.getModelVariants()

Parameters:

modelVariants - An array of ModelVariantConfigSummary objects. This parameter is required. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

Returns:

this

modelVariants

@Stability(Stable)
public CfnInferenceExperimentProps.Builder modelVariants(List<? extends Object> modelVariants)

Sets the value of CfnInferenceExperimentProps.getModelVariants()

Parameters:

modelVariants - An array of ModelVariantConfigSummary objects. This parameter is required. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

Returns:

this

name

@Stability(Stable)
public CfnInferenceExperimentProps.Builder name(String name)

Sets the value of CfnInferenceExperimentProps.getName()

Parameters:

name - The name of the inference experiment. This parameter is required.

Returns:

this

roleArn

@Stability(Stable)
public CfnInferenceExperimentProps.Builder roleArn(String roleArn)

Sets the value of CfnInferenceExperimentProps.getRoleArn()

Parameters:

roleArn - The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. This parameter is required.

Returns:

this

type

@Stability(Stable)
public CfnInferenceExperimentProps.Builder type(String type)

Sets the value of CfnInferenceExperimentProps.getType()

Parameters:

type - The type of the inference experiment. This parameter is required.

Returns:

this

dataStorageConfig

@Stability(Stable)
public CfnInferenceExperimentProps.Builder dataStorageConfig(IResolvable dataStorageConfig)

Sets the value of CfnInferenceExperimentProps.getDataStorageConfig()

Parameters:

dataStorageConfig - The Amazon S3 location and configuration for storing inference request and response data.

Returns:

this

dataStorageConfig

@Stability(Stable)
public CfnInferenceExperimentProps.Builder dataStorageConfig(CfnInferenceExperiment.DataStorageConfigProperty dataStorageConfig)

Sets the value of CfnInferenceExperimentProps.getDataStorageConfig()

Parameters:

dataStorageConfig - The Amazon S3 location and configuration for storing inference request and response data.

Returns:

this

description

@Stability(Stable)
public CfnInferenceExperimentProps.Builder description(String description)

Sets the value of CfnInferenceExperimentProps.getDescription()

Parameters:

description - The description of the inference experiment.

Returns:

this

desiredState

@Stability(Stable)
public CfnInferenceExperimentProps.Builder desiredState(String desiredState)

Sets the value of CfnInferenceExperimentProps.getDesiredState()

Parameters:

desiredState - The desired state of the experiment after stopping. The possible states are the following:.

• Completed : The experiment completed successfully
• Cancelled : The experiment was canceled

Returns:

this

kmsKey

@Stability(Stable)
public CfnInferenceExperimentProps.Builder kmsKey(String kmsKey)

Sets the value of CfnInferenceExperimentProps.getKmsKey()

Parameters:

kmsKey - The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

Returns:

this

schedule

@Stability(Stable)
public CfnInferenceExperimentProps.Builder schedule(IResolvable schedule)

Sets the value of CfnInferenceExperimentProps.getSchedule()

Parameters:

schedule - The duration for which the inference experiment ran or will run. The maximum duration that you can set for an inference experiment is 30 days.

Returns:

this

schedule

@Stability(Stable)
public CfnInferenceExperimentProps.Builder schedule(CfnInferenceExperiment.InferenceExperimentScheduleProperty schedule)

Sets the value of CfnInferenceExperimentProps.getSchedule()

Parameters:

schedule - The duration for which the inference experiment ran or will run. The maximum duration that you can set for an inference experiment is 30 days.

Returns:

this

shadowModeConfig

@Stability(Stable)
public CfnInferenceExperimentProps.Builder shadowModeConfig(IResolvable shadowModeConfig)

Sets the value of CfnInferenceExperimentProps.getShadowModeConfig()

Parameters:

shadowModeConfig - The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

Returns:

this

shadowModeConfig

@Stability(Stable)
public CfnInferenceExperimentProps.Builder shadowModeConfig(CfnInferenceExperiment.ShadowModeConfigProperty shadowModeConfig)

Sets the value of CfnInferenceExperimentProps.getShadowModeConfig()

Parameters:

shadowModeConfig - The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

Returns:

this

statusReason

@Stability(Stable)
public CfnInferenceExperimentProps.Builder statusReason(String statusReason)

Sets the value of CfnInferenceExperimentProps.getStatusReason()

Parameters:

statusReason - The error message for the inference experiment status result.

Returns:

this

tags

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

Sets the value of CfnInferenceExperimentProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource. For more information, see Tag .

Returns:

this

build

@Stability(Stable)
public CfnInferenceExperimentProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnInferenceExperimentProps

Throws:

NullPointerException - if any required attribute was not provided