software.amazon.awscdk.services.sagemaker

Class CfnModel.Builder

java.lang.Object

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

Enclosing class:

CfnModel

public static final class CfnModel.Builder
extends java.lang.Object

A fluent builder for CfnModel.

Method Summary

Modifier and Type	Method and Description
CfnModel	build()
CfnModel.Builder	containers(IResolvable containers) Specifies the containers in the inference pipeline.
CfnModel.Builder	containers(java.util.List<? extends java.lang.Object> containers) Specifies the containers in the inference pipeline.
static CfnModel.Builder	create(Construct scope, java.lang.String id)
CfnModel.Builder	enableNetworkIsolation(java.lang.Boolean enableNetworkIsolation) Isolates the model container.
CfnModel.Builder	enableNetworkIsolation(IResolvable enableNetworkIsolation) Isolates the model container.
CfnModel.Builder	executionRoleArn(java.lang.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(CfnModel.InferenceExecutionConfigProperty inferenceExecutionConfig) Specifies details of how containers in a multi-container endpoint are called.
CfnModel.Builder	inferenceExecutionConfig(IResolvable inferenceExecutionConfig) Specifies details of how containers in a multi-container endpoint are called.
CfnModel.Builder	modelName(java.lang.String modelName) The name of the new model.
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	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	tags(java.util.List<? extends CfnTag> tags) A list of key-value pairs to apply to this resource.
CfnModel.Builder	vpcConfig(CfnModel.VpcConfigProperty vpcConfig) A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) object that specifies the VPC that you want your model to connect to.
CfnModel.Builder	vpcConfig(IResolvable vpcConfig) A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) 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 Detail

create

public static CfnModel.Builder create(Construct scope,
                                      java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnModel.ContainerDefinitionProperty.Builder.

executionRoleArn

public CfnModel.Builder executionRoleArn(java.lang.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

containers

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

containers

public CfnModel.Builder containers(java.util.List<? extends java.lang.Object> containers)

Specifies the containers in the inference pipeline.

Parameters:

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

Returns:

this

enableNetworkIsolation

public CfnModel.Builder enableNetworkIsolation(java.lang.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

enableNetworkIsolation

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

inferenceExecutionConfig

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

inferenceExecutionConfig

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

modelName

public CfnModel.Builder modelName(java.lang.String modelName)

The name of the new model.

Parameters:

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

Returns:

this

primaryContainer

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

primaryContainer

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

tags

public CfnModel.Builder tags(java.util.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

vpcConfig

public CfnModel.Builder vpcConfig(IResolvable vpcConfig)

A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) .

Parameters:

vpcConfig - A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) . This parameter is required.

Returns:

this

vpcConfig

public CfnModel.Builder vpcConfig(CfnModel.VpcConfigProperty vpcConfig)

A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) .

Parameters:

vpcConfig - A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) 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](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) . This parameter is required.

Returns:

this

build

public CfnModel build()