Package software.amazon.awscdk.services.sagemaker

Class CfnEndpointConfig.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnEndpointConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointConfig>

Enclosing class:

CfnEndpointConfig

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

A fluent builder for CfnEndpointConfig.

Method Summary

Modifier and Type	Method	Description
CfnEndpointConfig.Builder	asyncInferenceConfig(IResolvable asyncInferenceConfig)	Specifies configuration for how an endpoint performs asynchronous inference.
CfnEndpointConfig.Builder	asyncInferenceConfig(CfnEndpointConfig.AsyncInferenceConfigProperty asyncInferenceConfig)	Specifies configuration for how an endpoint performs asynchronous inference.
CfnEndpointConfig	build()
static CfnEndpointConfig.Builder	create(software.constructs.Construct scope, String id)
CfnEndpointConfig.Builder	dataCaptureConfig(IResolvable dataCaptureConfig)	Specifies how to capture endpoint data for model monitor.
CfnEndpointConfig.Builder	dataCaptureConfig(CfnEndpointConfig.DataCaptureConfigProperty dataCaptureConfig)	Specifies how to capture endpoint data for model monitor.
CfnEndpointConfig.Builder	enableNetworkIsolation(Boolean enableNetworkIsolation)
CfnEndpointConfig.Builder	enableNetworkIsolation(IResolvable enableNetworkIsolation)
CfnEndpointConfig.Builder	endpointConfigName(String endpointConfigName)	The name of the endpoint configuration.
CfnEndpointConfig.Builder	executionRoleArn(String executionRoleArn)
CfnEndpointConfig.Builder	explainerConfig(IResolvable explainerConfig)	A parameter to activate explainers.
CfnEndpointConfig.Builder	explainerConfig(CfnEndpointConfig.ExplainerConfigProperty explainerConfig)	A parameter to activate explainers.
CfnEndpointConfig.Builder	kmsKeyId(String 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.
CfnEndpointConfig.Builder	productionVariants(List<? extends Object> productionVariants)	A list of ProductionVariant objects, one for each model that you want to host at this endpoint.
CfnEndpointConfig.Builder	productionVariants(IResolvable productionVariants)	A list of ProductionVariant objects, one for each model that you want to host at this endpoint.
CfnEndpointConfig.Builder	shadowProductionVariants(List<? extends Object> shadowProductionVariants)	Array of ProductionVariant objects.
CfnEndpointConfig.Builder	shadowProductionVariants(IResolvable shadowProductionVariants)	Array of ProductionVariant objects.
CfnEndpointConfig.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to apply to this resource.
CfnEndpointConfig.Builder	vpcConfig(IResolvable vpcConfig)
CfnEndpointConfig.Builder	vpcConfig(CfnEndpointConfig.VpcConfigProperty vpcConfig)

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEndpointConfig.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 CfnEndpointConfig.Builder.

productionVariants

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

A list of ProductionVariant objects, one for each model that you want to host at this endpoint.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-productionvariants

productionVariants

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

A list of ProductionVariant objects, one for each model that you want to host at this endpoint.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-productionvariants

asyncInferenceConfig

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

Specifies configuration for how an endpoint performs asynchronous inference.

Parameters:

asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig

asyncInferenceConfig

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

Specifies configuration for how an endpoint performs asynchronous inference.

Parameters:

asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-asyncinferenceconfig

dataCaptureConfig

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

Specifies how to capture endpoint data for model monitor.

The data capture configuration applies to all production variants hosted at the endpoint.

Parameters:

dataCaptureConfig - Specifies how to capture endpoint data for model monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig

dataCaptureConfig

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

Specifies how to capture endpoint data for model monitor.

The data capture configuration applies to all production variants hosted at the endpoint.

Parameters:

dataCaptureConfig - Specifies how to capture endpoint data for model monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-datacaptureconfig

enableNetworkIsolation

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

Parameters:

enableNetworkIsolation - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-enablenetworkisolation

enableNetworkIsolation

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

Parameters:

enableNetworkIsolation - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-enablenetworkisolation

endpointConfigName

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

The name of the endpoint configuration.

Parameters:

endpointConfigName - The name of the endpoint configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-endpointconfigname

executionRoleArn

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

Parameters:

executionRoleArn - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-executionrolearn

explainerConfig

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

A parameter to activate explainers.

Parameters:

explainerConfig - A parameter to activate explainers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-explainerconfig

explainerConfig

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

A parameter to activate explainers.

Parameters:

explainerConfig - A parameter to activate explainers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-explainerconfig

kmsKeyId

@Stability(Stable)
public CfnEndpointConfig.Builder kmsKeyId(String 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 .

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-kmskeyid

shadowProductionVariants

@Stability(Stable)
public CfnEndpointConfig.Builder shadowProductionVariants(IResolvable 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 .

Parameters:

shadowProductionVariants - Array of ProductionVariant objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-shadowproductionvariants

shadowProductionVariants

@Stability(Stable)
public CfnEndpointConfig.Builder shadowProductionVariants(List<? extends Object> 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 .

Parameters:

shadowProductionVariants - Array of ProductionVariant objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-shadowproductionvariants

tags

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

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags .

Parameters:

tags - A list of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-tags

vpcConfig

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

Parameters:

vpcConfig - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-vpcconfig

vpcConfig

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

Parameters:

vpcConfig - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html#cfn-sagemaker-endpointconfig-vpcconfig

build

@Stability(Stable)
public CfnEndpointConfig build()

Specified by:

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

Returns:

a newly built instance of CfnEndpointConfig.