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

Class CfnInferenceExperimentMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInferenceExperimentMixinProps>

Enclosing interface:

CfnInferenceExperimentMixinProps

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

A builder for CfnInferenceExperimentMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

dataStorageConfig

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

Sets the value of CfnInferenceExperimentMixinProps.getDataStorageConfig()

Parameters:

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

Returns:

this

dataStorageConfig

@Stability(Stable)
public CfnInferenceExperimentMixinProps.Builder dataStorageConfig(CfnInferenceExperimentPropsMixin.DataStorageConfigProperty dataStorageConfig)

Sets the value of CfnInferenceExperimentMixinProps.getDataStorageConfig()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnInferenceExperimentMixinProps.getDescription()

Parameters:

description - The description of the inference experiment.

Returns:

this

desiredState

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

Sets the value of CfnInferenceExperimentMixinProps.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

endpointName

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

Sets the value of CfnInferenceExperimentMixinProps.getEndpointName()

Parameters:

endpointName - The name of the endpoint.

Returns:

this

kmsKey

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

Sets the value of CfnInferenceExperimentMixinProps.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

modelVariants

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

Sets the value of CfnInferenceExperimentMixinProps.getModelVariants()

Parameters:

modelVariants - An array of ModelVariantConfigSummary objects. 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 CfnInferenceExperimentMixinProps.Builder modelVariants(List<? extends Object> modelVariants)

Sets the value of CfnInferenceExperimentMixinProps.getModelVariants()

Parameters:

modelVariants - An array of ModelVariantConfigSummary objects. 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 CfnInferenceExperimentMixinProps.Builder name(String name)

Sets the value of CfnInferenceExperimentMixinProps.getName()

Parameters:

name - The name of the inference experiment.

Returns:

this

roleArn

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

Sets the value of CfnInferenceExperimentMixinProps.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.

Returns:

this

schedule

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

Sets the value of CfnInferenceExperimentMixinProps.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 CfnInferenceExperimentMixinProps.Builder schedule(CfnInferenceExperimentPropsMixin.InferenceExperimentScheduleProperty schedule)

Sets the value of CfnInferenceExperimentMixinProps.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 CfnInferenceExperimentMixinProps.Builder shadowModeConfig(IResolvable shadowModeConfig)

Sets the value of CfnInferenceExperimentMixinProps.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 CfnInferenceExperimentMixinProps.Builder shadowModeConfig(CfnInferenceExperimentPropsMixin.ShadowModeConfigProperty shadowModeConfig)

Sets the value of CfnInferenceExperimentMixinProps.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 CfnInferenceExperimentMixinProps.Builder statusReason(String statusReason)

Sets the value of CfnInferenceExperimentMixinProps.getStatusReason()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnInferenceExperimentMixinProps.getTags()

Parameters:

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

Returns:

this

type

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

Sets the value of CfnInferenceExperimentMixinProps.getType()

Parameters:

type - The type of the inference experiment.

Returns:

this

build

@Stability(Stable)
public CfnInferenceExperimentMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnInferenceExperimentMixinProps

Throws:

NullPointerException - if any required attribute was not provided