Package software.amazon.awscdk.services.sagemaker

Class CfnEndpointConfigProps.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnEndpointConfigProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointConfigProps>

Enclosing interface:

CfnEndpointConfigProps

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

A builder for CfnEndpointConfigProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpointConfigProps.Builder	asyncInferenceConfig(IResolvable asyncInferenceConfig)	Sets the value of CfnEndpointConfigProps.getAsyncInferenceConfig()
CfnEndpointConfigProps.Builder	asyncInferenceConfig(CfnEndpointConfig.AsyncInferenceConfigProperty asyncInferenceConfig)	Sets the value of CfnEndpointConfigProps.getAsyncInferenceConfig()
CfnEndpointConfigProps	build()	Builds the configured instance.
CfnEndpointConfigProps.Builder	dataCaptureConfig(IResolvable dataCaptureConfig)	Sets the value of CfnEndpointConfigProps.getDataCaptureConfig()
CfnEndpointConfigProps.Builder	dataCaptureConfig(CfnEndpointConfig.DataCaptureConfigProperty dataCaptureConfig)	Sets the value of CfnEndpointConfigProps.getDataCaptureConfig()
CfnEndpointConfigProps.Builder	enableNetworkIsolation(Boolean enableNetworkIsolation)	Sets the value of CfnEndpointConfigProps.getEnableNetworkIsolation()
CfnEndpointConfigProps.Builder	enableNetworkIsolation(IResolvable enableNetworkIsolation)	Sets the value of CfnEndpointConfigProps.getEnableNetworkIsolation()
CfnEndpointConfigProps.Builder	endpointConfigName(String endpointConfigName)	Sets the value of CfnEndpointConfigProps.getEndpointConfigName()
CfnEndpointConfigProps.Builder	executionRoleArn(String executionRoleArn)	Sets the value of CfnEndpointConfigProps.getExecutionRoleArn()
CfnEndpointConfigProps.Builder	explainerConfig(IResolvable explainerConfig)	Sets the value of CfnEndpointConfigProps.getExplainerConfig()
CfnEndpointConfigProps.Builder	explainerConfig(CfnEndpointConfig.ExplainerConfigProperty explainerConfig)	Sets the value of CfnEndpointConfigProps.getExplainerConfig()
CfnEndpointConfigProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnEndpointConfigProps.getKmsKeyId()
CfnEndpointConfigProps.Builder	productionVariants(List<? extends Object> productionVariants)	Sets the value of CfnEndpointConfigProps.getProductionVariants()
CfnEndpointConfigProps.Builder	productionVariants(IResolvable productionVariants)	Sets the value of CfnEndpointConfigProps.getProductionVariants()
CfnEndpointConfigProps.Builder	shadowProductionVariants(List<? extends Object> shadowProductionVariants)	Sets the value of CfnEndpointConfigProps.getShadowProductionVariants()
CfnEndpointConfigProps.Builder	shadowProductionVariants(IResolvable shadowProductionVariants)	Sets the value of CfnEndpointConfigProps.getShadowProductionVariants()
CfnEndpointConfigProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnEndpointConfigProps.getTags()
CfnEndpointConfigProps.Builder	vpcConfig(IResolvable vpcConfig)	Sets the value of CfnEndpointConfigProps.getVpcConfig()
CfnEndpointConfigProps.Builder	vpcConfig(CfnEndpointConfig.VpcConfigProperty vpcConfig)	Sets the value of CfnEndpointConfigProps.getVpcConfig()

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

productionVariants

@Stability(Stable)
public CfnEndpointConfigProps.Builder productionVariants(IResolvable productionVariants)

Sets the value of CfnEndpointConfigProps.getProductionVariants()

Parameters:

productionVariants - A list of ProductionVariant objects, one for each model that you want to host at this endpoint. This parameter is required.

Returns:

this

productionVariants

@Stability(Stable)
public CfnEndpointConfigProps.Builder productionVariants(List<? extends Object> productionVariants)

Sets the value of CfnEndpointConfigProps.getProductionVariants()

Parameters:

productionVariants - A list of ProductionVariant objects, one for each model that you want to host at this endpoint. This parameter is required.

Returns:

this

asyncInferenceConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder asyncInferenceConfig(IResolvable asyncInferenceConfig)

Sets the value of CfnEndpointConfigProps.getAsyncInferenceConfig()

Parameters:

asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference.

Returns:

this

asyncInferenceConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder asyncInferenceConfig(CfnEndpointConfig.AsyncInferenceConfigProperty asyncInferenceConfig)

Sets the value of CfnEndpointConfigProps.getAsyncInferenceConfig()

Parameters:

asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference.

Returns:

this

dataCaptureConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder dataCaptureConfig(IResolvable dataCaptureConfig)

Sets the value of CfnEndpointConfigProps.getDataCaptureConfig()

Parameters:

dataCaptureConfig - Specifies how to capture endpoint data for model monitor. The data capture configuration applies to all production variants hosted at the endpoint.

Returns:

this

dataCaptureConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder dataCaptureConfig(CfnEndpointConfig.DataCaptureConfigProperty dataCaptureConfig)

Sets the value of CfnEndpointConfigProps.getDataCaptureConfig()

Parameters:

dataCaptureConfig - Specifies how to capture endpoint data for model monitor. The data capture configuration applies to all production variants hosted at the endpoint.

Returns:

this

enableNetworkIsolation

@Stability(Stable)
public CfnEndpointConfigProps.Builder enableNetworkIsolation(Boolean enableNetworkIsolation)

Sets the value of CfnEndpointConfigProps.getEnableNetworkIsolation()

Parameters:

enableNetworkIsolation - the value to be set.

Returns:

this

enableNetworkIsolation

@Stability(Stable)
public CfnEndpointConfigProps.Builder enableNetworkIsolation(IResolvable enableNetworkIsolation)

Sets the value of CfnEndpointConfigProps.getEnableNetworkIsolation()

Parameters:

enableNetworkIsolation - the value to be set.

Returns:

this

endpointConfigName

@Stability(Stable)
public CfnEndpointConfigProps.Builder endpointConfigName(String endpointConfigName)

Sets the value of CfnEndpointConfigProps.getEndpointConfigName()

Parameters:

endpointConfigName - The name of the endpoint configuration.

Returns:

this

executionRoleArn

@Stability(Stable)
public CfnEndpointConfigProps.Builder executionRoleArn(String executionRoleArn)

Sets the value of CfnEndpointConfigProps.getExecutionRoleArn()

Parameters:

executionRoleArn - the value to be set.

Returns:

this

explainerConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder explainerConfig(IResolvable explainerConfig)

Sets the value of CfnEndpointConfigProps.getExplainerConfig()

Parameters:

explainerConfig - A parameter to activate explainers.

Returns:

this

explainerConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder explainerConfig(CfnEndpointConfig.ExplainerConfigProperty explainerConfig)

Sets the value of CfnEndpointConfigProps.getExplainerConfig()

Parameters:

explainerConfig - A parameter to activate explainers.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnEndpointConfigProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnEndpointConfigProps.getKmsKeyId()

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint , UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes .

For more information about local instance storage encryption, see SSD Instance Store Volumes .

Returns:

this

shadowProductionVariants

@Stability(Stable)
public CfnEndpointConfigProps.Builder shadowProductionVariants(IResolvable shadowProductionVariants)

Sets the value of CfnEndpointConfigProps.getShadowProductionVariants()

Parameters:

shadowProductionVariants - Array of ProductionVariant objects. There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants . If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants .

Returns:

this

shadowProductionVariants

@Stability(Stable)
public CfnEndpointConfigProps.Builder shadowProductionVariants(List<? extends Object> shadowProductionVariants)

Sets the value of CfnEndpointConfigProps.getShadowProductionVariants()

Parameters:

shadowProductionVariants - Array of ProductionVariant objects. There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants . If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants .

Returns:

this

tags

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

Sets the value of CfnEndpointConfigProps.getTags()

Parameters:

tags - A list of key-value pairs to apply to this resource. For more information, see Resource Tag and Using Cost Allocation Tags .

Returns:

this

vpcConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder vpcConfig(IResolvable vpcConfig)

Sets the value of CfnEndpointConfigProps.getVpcConfig()

Parameters:

vpcConfig - the value to be set.

Returns:

this

vpcConfig

@Stability(Stable)
public CfnEndpointConfigProps.Builder vpcConfig(CfnEndpointConfig.VpcConfigProperty vpcConfig)

Sets the value of CfnEndpointConfigProps.getVpcConfig()

Parameters:

vpcConfig - the value to be set.

Returns:

this

build

@Stability(Stable)
public CfnEndpointConfigProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnEndpointConfigProps

Throws:

NullPointerException - if any required attribute was not provided