Interface CreateModelRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>, SageMakerRequest.Builder, SdkBuilder<CreateModelRequest.Builder,CreateModelRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateModelRequest

@Mutable
@NotThreadSafe
public static interface CreateModelRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

Method Summary

Modifier and Type	Method	Description
CreateModelRequest.Builder	containers(Collection<ContainerDefinition> containers)	Specifies the containers in the inference pipeline.
CreateModelRequest.Builder	containers(Consumer<ContainerDefinition.Builder>... containers)	Specifies the containers in the inference pipeline.
CreateModelRequest.Builder	containers(ContainerDefinition... containers)	Specifies the containers in the inference pipeline.
CreateModelRequest.Builder	enableNetworkIsolation(Boolean enableNetworkIsolation)	Isolates the model container.
CreateModelRequest.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.
default CreateModelRequest.Builder	inferenceExecutionConfig(Consumer<InferenceExecutionConfig.Builder> inferenceExecutionConfig)	Specifies details of how containers in a multi-container endpoint are called.
CreateModelRequest.Builder	inferenceExecutionConfig(InferenceExecutionConfig inferenceExecutionConfig)	Specifies details of how containers in a multi-container endpoint are called.
CreateModelRequest.Builder	modelName(String modelName)	The name of the new model.
CreateModelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateModelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateModelRequest.Builder	primaryContainer(Consumer<ContainerDefinition.Builder> 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.
CreateModelRequest.Builder	primaryContainer(ContainerDefinition 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.
CreateModelRequest.Builder	tags(Collection<Tag> tags)	An array of key-value pairs.
CreateModelRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An array of key-value pairs.
CreateModelRequest.Builder	tags(Tag... tags)	An array of key-value pairs.
default CreateModelRequest.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)	A VpcConfig object that specifies the VPC that you want your model to connect to.
CreateModelRequest.Builder	vpcConfig(VpcConfig vpcConfig)	A VpcConfig object that specifies the VPC that you want your model to connect to.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

modelName

CreateModelRequest.Builder modelName(String modelName)

The name of the new model.

Parameters:

modelName - The name of the new model.

Returns:

Returns a reference to this object so that method calls can be chained together.

primaryContainer

CreateModelRequest.Builder primaryContainer(ContainerDefinition 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

primaryContainer

default CreateModelRequest.Builder primaryContainer(Consumer<ContainerDefinition.Builder> 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 is a convenience method that creates an instance of the ContainerDefinition.Builder avoiding the need to create one manually via ContainerDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to primaryContainer(ContainerDefinition).

Parameters:

primaryContainer - a consumer that will call methods on ContainerDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• primaryContainer(ContainerDefinition)

containers

CreateModelRequest.Builder containers(Collection<ContainerDefinition> containers)

Specifies the containers in the inference pipeline.

Parameters:

containers - Specifies the containers in the inference pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

containers

CreateModelRequest.Builder containers(ContainerDefinition... containers)

Specifies the containers in the inference pipeline.

Parameters:

containers - Specifies the containers in the inference pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

containers

CreateModelRequest.Builder containers(Consumer<ContainerDefinition.Builder>... containers)

Specifies the containers in the inference pipeline.

This is a convenience method that creates an instance of the ContainerDefinition.Builder avoiding the need to create one manually via ContainerDefinition.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containers(List<ContainerDefinition>).

Parameters:

containers - a consumer that will call methods on ContainerDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• containers(java.util.Collection<ContainerDefinition>)

inferenceExecutionConfig

CreateModelRequest.Builder inferenceExecutionConfig(InferenceExecutionConfig 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

inferenceExecutionConfig

default CreateModelRequest.Builder inferenceExecutionConfig(Consumer<InferenceExecutionConfig.Builder> inferenceExecutionConfig)

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

This is a convenience method that creates an instance of the InferenceExecutionConfig.Builder avoiding the need to create one manually via InferenceExecutionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceExecutionConfig(InferenceExecutionConfig).

Parameters:

inferenceExecutionConfig - a consumer that will call methods on InferenceExecutionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• inferenceExecutionConfig(InferenceExecutionConfig)

executionRoleArn

CreateModelRequest.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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateModelRequest.Builder tags(Collection<Tag> tags)

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Parameters:

tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateModelRequest.Builder tags(Tag... tags)

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Parameters:

tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateModelRequest.Builder tags(Consumer<Tag.Builder>... tags)

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

vpcConfig

CreateModelRequest.Builder vpcConfig(VpcConfig 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcConfig

default CreateModelRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> 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 is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

Parameters:

vpcConfig - a consumer that will call methods on VpcConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• vpcConfig(VpcConfig)

enableNetworkIsolation

CreateModelRequest.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. No inbound or outbound network calls can be made to or from the model container.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.