software.amazon.awssdk.services.sagemaker.model

Interface CreateImageVersionRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateImageVersionRequest

public static interface CreateImageVersionRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateImageVersionRequest.Builder,CreateImageVersionRequest>

Method Summary

Modifier and Type	Method and Description
CreateImageVersionRequest.Builder	aliases(Collection<String> aliases) A list of aliases created with the image version.
CreateImageVersionRequest.Builder	aliases(String... aliases) A list of aliases created with the image version.
CreateImageVersionRequest.Builder	baseImage(String baseImage) The registry path of the container image to use as the starting point for this version.
CreateImageVersionRequest.Builder	clientToken(String clientToken) A unique ID.
CreateImageVersionRequest.Builder	horovod(Boolean horovod) Indicates Horovod compatibility.
CreateImageVersionRequest.Builder	imageName(String imageName) The ImageName of the Image to create a version of.
CreateImageVersionRequest.Builder	jobType(JobType jobType) Indicates SageMaker job type compatibility.
CreateImageVersionRequest.Builder	jobType(String jobType) Indicates SageMaker job type compatibility.
CreateImageVersionRequest.Builder	mlFramework(String mlFramework) The machine learning framework vended in the image version.
CreateImageVersionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateImageVersionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateImageVersionRequest.Builder	processor(Processor processor) Indicates CPU or GPU compatibility.
CreateImageVersionRequest.Builder	processor(String processor) Indicates CPU or GPU compatibility.
CreateImageVersionRequest.Builder	programmingLang(String programmingLang) The supported programming language and its version.
CreateImageVersionRequest.Builder	releaseNotes(String releaseNotes) The maintainer description of the image version.
CreateImageVersionRequest.Builder	vendorGuidance(String vendorGuidance) The stability of the image version, specified by the maintainer.
CreateImageVersionRequest.Builder	vendorGuidance(VendorGuidance vendorGuidance) The stability of the image version, specified by the maintainer.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

baseImage

CreateImageVersionRequest.Builder baseImage(String baseImage)

The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

Parameters:

baseImage - The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

Returns:

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

clientToken

CreateImageVersionRequest.Builder clientToken(String clientToken)

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

Parameters:

clientToken - A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

Returns:

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

imageName

CreateImageVersionRequest.Builder imageName(String imageName)

The ImageName of the Image to create a version of.

Parameters:

imageName - The ImageName of the Image to create a version of.

Returns:

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

aliases

CreateImageVersionRequest.Builder aliases(Collection<String> aliases)

A list of aliases created with the image version.

Parameters:

aliases - A list of aliases created with the image version.

Returns:

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

aliases

CreateImageVersionRequest.Builder aliases(String... aliases)

A list of aliases created with the image version.

Parameters:

aliases - A list of aliases created with the image version.

Returns:

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

vendorGuidance

CreateImageVersionRequest.Builder vendorGuidance(String vendorGuidance)

The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

Parameters:

vendorGuidance - The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

Returns:

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

See Also:

VendorGuidance, VendorGuidance

vendorGuidance

CreateImageVersionRequest.Builder vendorGuidance(VendorGuidance vendorGuidance)

The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

Parameters:

vendorGuidance - The stability of the image version, specified by the maintainer.

• NOT_PROVIDED: The maintainers did not provide a status for image version stability.

• STABLE: The image version is stable.

• TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

• ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

Returns:

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

See Also:

VendorGuidance, VendorGuidance

jobType

CreateImageVersionRequest.Builder jobType(String jobType)

Indicates SageMaker job type compatibility.

• TRAINING: The image version is compatible with SageMaker training jobs.

• INFERENCE: The image version is compatible with SageMaker inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

Parameters:

jobType - Indicates SageMaker job type compatibility.

• TRAINING: The image version is compatible with SageMaker training jobs.

• INFERENCE: The image version is compatible with SageMaker inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

Returns:

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

See Also:

JobType, JobType

jobType

CreateImageVersionRequest.Builder jobType(JobType jobType)

Indicates SageMaker job type compatibility.

• TRAINING: The image version is compatible with SageMaker training jobs.

• INFERENCE: The image version is compatible with SageMaker inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

Parameters:

jobType - Indicates SageMaker job type compatibility.

• TRAINING: The image version is compatible with SageMaker training jobs.

• INFERENCE: The image version is compatible with SageMaker inference jobs.

• NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

Returns:

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

See Also:

JobType, JobType

mlFramework

CreateImageVersionRequest.Builder mlFramework(String mlFramework)

The machine learning framework vended in the image version.

Parameters:

mlFramework - The machine learning framework vended in the image version.

Returns:

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

programmingLang

CreateImageVersionRequest.Builder programmingLang(String programmingLang)

The supported programming language and its version.

Parameters:

programmingLang - The supported programming language and its version.

Returns:

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

processor

CreateImageVersionRequest.Builder processor(String processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Returns:

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

See Also:

Processor, Processor

processor

CreateImageVersionRequest.Builder processor(Processor processor)

Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Parameters:

processor - Indicates CPU or GPU compatibility.

• CPU: The image version is compatible with CPU.

• GPU: The image version is compatible with GPU.

Returns:

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

See Also:

Processor, Processor

horovod

CreateImageVersionRequest.Builder horovod(Boolean horovod)

Indicates Horovod compatibility.

Parameters:

horovod - Indicates Horovod compatibility.

Returns:

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

releaseNotes

CreateImageVersionRequest.Builder releaseNotes(String releaseNotes)

The maintainer description of the image version.

Parameters:

releaseNotes - The maintainer description of the image version.

Returns:

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

overrideConfiguration

CreateImageVersionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder