Package software.amazon.awscdk.services.sagemaker

Class CfnModel.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnModel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnModel>

Enclosing class:

CfnModel

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

A fluent builder for CfnModel.

Method Summary

Modifier and Type	Method	Description
CfnModel	build()
CfnModel.Builder	containers(List<? extends Object> containers)	Specifies the containers in the inference pipeline.
CfnModel.Builder	containers(IResolvable containers)	Specifies the containers in the inference pipeline.
static CfnModel.Builder	create(software.constructs.Construct scope, String id)
CfnModel.Builder	enableNetworkIsolation(Boolean enableNetworkIsolation)	Isolates the model container.
CfnModel.Builder	enableNetworkIsolation(IResolvable enableNetworkIsolation)	Isolates the model container.
CfnModel.Builder	executionRoleArn(String executionRoleArn)	The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs.
CfnModel.Builder	inferenceExecutionConfig(IResolvable inferenceExecutionConfig)	Specifies details of how containers in a multi-container endpoint are called.
CfnModel.Builder	inferenceExecutionConfig(CfnModel.InferenceExecutionConfigProperty inferenceExecutionConfig)	Specifies details of how containers in a multi-container endpoint are called.
CfnModel.Builder	modelName(String modelName)	The name of the new model.
CfnModel.Builder	primaryContainer(IResolvable primaryContainer)	The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
CfnModel.Builder	primaryContainer(CfnModel.ContainerDefinitionProperty primaryContainer)	The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
CfnModel.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to apply to this resource.
CfnModel.Builder	vpcConfig(IResolvable vpcConfig)	A VpcConfig object that specifies the VPC that you want your model to connect to.
CfnModel.Builder	vpcConfig(CfnModel.VpcConfigProperty vpcConfig)	A VpcConfig object that specifies the VPC that you want your model to connect to.

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 CfnModel.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 CfnModel.Builder.

containers

@Stability(Stable)
public CfnModel.Builder containers(IResolvable containers)

Specifies the containers in the inference pipeline.

Parameters:

containers - Specifies the containers in the inference pipeline. This parameter is required.

Returns:

this

See Also:

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

containers

@Stability(Stable)
public CfnModel.Builder containers(List<? extends Object> containers)

Specifies the containers in the inference pipeline.

Parameters:

containers - Specifies the containers in the inference pipeline. This parameter is required.

Returns:

this

See Also:

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

enableNetworkIsolation

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

Isolates the model container.

No inbound or outbound network calls can be made to or from the model container.

Parameters:

enableNetworkIsolation - Isolates the model container. This parameter is required.

Returns:

this

See Also:

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

enableNetworkIsolation

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

Isolates the model container.

No inbound or outbound network calls can be made to or from the model container.

Parameters:

enableNetworkIsolation - Isolates the model container. This parameter is required.

Returns:

this

See Also:

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

executionRoleArn

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

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs.

Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles .

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. This parameter is required.

Returns:

this

See Also:

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

inferenceExecutionConfig

@Stability(Stable)
public CfnModel.Builder inferenceExecutionConfig(IResolvable inferenceExecutionConfig)

Specifies details of how containers in a multi-container endpoint are called.

Parameters:

inferenceExecutionConfig - Specifies details of how containers in a multi-container endpoint are called. This parameter is required.

Returns:

this

See Also:

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

inferenceExecutionConfig

@Stability(Stable)
public CfnModel.Builder inferenceExecutionConfig(CfnModel.InferenceExecutionConfigProperty inferenceExecutionConfig)

Specifies details of how containers in a multi-container endpoint are called.

Parameters:

inferenceExecutionConfig - Specifies details of how containers in a multi-container endpoint are called. This parameter is required.

Returns:

this

See Also:

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

modelName

@Stability(Stable)
public CfnModel.Builder modelName(String modelName)

The name of the new model.

Parameters:

modelName - The name of the new model. This parameter is required.

Returns:

this

See Also:

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

primaryContainer

@Stability(Stable)
public CfnModel.Builder primaryContainer(IResolvable primaryContainer)

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

Parameters:

primaryContainer - The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. This parameter is required.

Returns:

this

See Also:

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

primaryContainer

@Stability(Stable)
public CfnModel.Builder primaryContainer(CfnModel.ContainerDefinitionProperty primaryContainer)

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

Parameters:

primaryContainer - The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnModel.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 in the AWS Billing and Cost Management User Guide .

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-model.html#cfn-sagemaker-model-tags

vpcConfig

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

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud .

Parameters:

vpcConfig - A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud . This parameter is required.

Returns:

this

See Also:

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

vpcConfig

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

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud .

Parameters:

vpcConfig - A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud . This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnModel build()

Specified by:

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

Returns:

a newly built instance of CfnModel.