Package software.amazon.awscdk.services.sagemaker

Class CfnImageVersion.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnImageVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImageVersion>

Enclosing class:

CfnImageVersion

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

A fluent builder for CfnImageVersion.

Method Summary

Modifier and Type	Method	Description
CfnImageVersion.Builder	alias(String alias)	The alias of the image version.
CfnImageVersion.Builder	aliases(List<String> aliases)	List of aliases for the image version.
CfnImageVersion.Builder	baseImage(String baseImage)	The container image that the SageMaker image version is based on.
CfnImageVersion	build()
static CfnImageVersion.Builder	create(software.constructs.Construct scope, String id)
CfnImageVersion.Builder	horovod(Boolean horovod)	Indicates Horovod compatibility.
CfnImageVersion.Builder	horovod(IResolvable horovod)	Indicates Horovod compatibility.
CfnImageVersion.Builder	imageName(String imageName)	The name of the parent image.
CfnImageVersion.Builder	jobType(String jobType)	Indicates SageMaker job type compatibility.
CfnImageVersion.Builder	mlFramework(String mlFramework)	The machine learning framework vended in the image version.
CfnImageVersion.Builder	processor(String processor)	Indicates CPU or GPU compatibility.
CfnImageVersion.Builder	programmingLang(String programmingLang)	The supported programming language and its version.
CfnImageVersion.Builder	releaseNotes(String releaseNotes)	The maintainer description of the image version.
CfnImageVersion.Builder	vendorGuidance(String vendorGuidance)	The availability of the image version specified by the maintainer.

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

baseImage

@Stability(Stable)
public CfnImageVersion.Builder baseImage(String baseImage)

The container image that the SageMaker image version is based on.

Parameters:

baseImage - The container image that the SageMaker image version is based on. This parameter is required.

Returns:

this

See Also:

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

imageName

@Stability(Stable)
public CfnImageVersion.Builder imageName(String imageName)

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Parameters:

imageName - The name of the parent image. This parameter is required.

Returns:

this

See Also:

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

alias

@Stability(Stable)
public CfnImageVersion.Builder alias(String alias)

The alias of the image version.

Parameters:

alias - The alias of the image version. This parameter is required.

Returns:

this

See Also:

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

aliases

@Stability(Stable)
public CfnImageVersion.Builder aliases(List<String> aliases)

List of aliases for the image version.

Parameters:

aliases - List of aliases for the image version. This parameter is required.

Returns:

this

See Also:

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

horovod

@Stability(Stable)
public CfnImageVersion.Builder horovod(Boolean horovod)

Indicates Horovod compatibility.

Parameters:

horovod - Indicates Horovod compatibility. This parameter is required.

Returns:

this

See Also:

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

horovod

@Stability(Stable)
public CfnImageVersion.Builder horovod(IResolvable horovod)

Indicates Horovod compatibility.

Parameters:

horovod - Indicates Horovod compatibility. This parameter is required.

Returns:

this

See Also:

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

jobType

@Stability(Stable)
public CfnImageVersion.Builder jobType(String jobType)

Indicates SageMaker job type compatibility.

Parameters:

jobType - Indicates SageMaker job type compatibility. This parameter is required.

Returns:

this

See Also:

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

mlFramework

@Stability(Stable)
public CfnImageVersion.Builder mlFramework(String mlFramework)

The machine learning framework vended in the image version.

Parameters:

mlFramework - The machine learning framework vended in the image version. This parameter is required.

Returns:

this

See Also:

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

processor

@Stability(Stable)
public CfnImageVersion.Builder processor(String processor)

Indicates CPU or GPU compatibility.

Parameters:

processor - Indicates CPU or GPU compatibility. This parameter is required.

Returns:

this

See Also:

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

programmingLang

@Stability(Stable)
public CfnImageVersion.Builder programmingLang(String programmingLang)

The supported programming language and its version.

Parameters:

programmingLang - The supported programming language and its version. This parameter is required.

Returns:

this

See Also:

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

releaseNotes

@Stability(Stable)
public CfnImageVersion.Builder releaseNotes(String releaseNotes)

The maintainer description of the image version.

Parameters:

releaseNotes - The maintainer description of the image version. This parameter is required.

Returns:

this

See Also:

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

vendorGuidance

@Stability(Stable)
public CfnImageVersion.Builder vendorGuidance(String vendorGuidance)

The availability of the image version specified by the maintainer.

Parameters:

vendorGuidance - The availability of the image version specified by the maintainer. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnImageVersion build()

Specified by:

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

Returns:

a newly built instance of CfnImageVersion.