software.amazon.awscdk.services.codebuild

Class LinuxGpuBuildImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.LinuxGpuBuildImage

All Implemented Interfaces:

IBindableBuildImage, IBuildImage, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:56.545Z")
 @Stability(value=Experimental)
public class LinuxGpuBuildImage
extends software.amazon.jsii.JsiiObject
implements IBindableBuildImage

(experimental) A CodeBuild GPU image running Linux.

This class has public constants that represent the most popular GPU images from AWS Deep Learning Containers.

See Also:

https://aws.amazon.com/releasenotes/available-deep-learning-containers-images

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IBindableBuildImage

IBindableBuildImage.Jsii$Default, IBindableBuildImage.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
static IBuildImage	DLC_MXNET_1_4_1 (experimental) MXNet 1.4.1 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_MXNET_1_6_0 (experimental) MXNet 1.6.0 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_PYTORCH_1_2_0 (experimental) PyTorch 1.2.0 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_PYTORCH_1_3_1 (experimental) PyTorch 1.3.1 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_PYTORCH_1_4_0_INFERENCE (experimental) PyTorch 1.4.0 GPU inference image from AWS Deep Learning Containers.
static IBuildImage	DLC_PYTORCH_1_4_0_TRAINING (experimental) PyTorch 1.4.0 GPU training image from AWS Deep Learning Containers.
static IBuildImage	DLC_PYTORCH_1_5_0_INFERENCE (experimental) PyTorch 1.5.0 GPU inference image from AWS Deep Learning Containers.
static IBuildImage	DLC_PYTORCH_1_5_0_TRAINING (experimental) PyTorch 1.5.0 GPU training image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_1_14_0 (experimental) Tensorflow 1.14.0 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_1_15_0 (experimental) Tensorflow 1.15.0 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_1_15_2_INFERENCE (experimental) Tensorflow 1.15.2 GPU inference image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_1_15_2_TRAINING (experimental) Tensorflow 1.15.2 GPU training image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_2_0_0 (experimental) Tensorflow 2.0.0 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_2_0_1 (experimental) Tensorflow 2.0.1 GPU image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_2_1_0_INFERENCE (experimental) Tensorflow 2.1.0 GPU inference image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_2_1_0_TRAINING (experimental) Tensorflow 2.1.0 GPU training image from AWS Deep Learning Containers.
static IBuildImage	DLC_TENSORFLOW_2_2_0_TRAINING (experimental) Tensorflow 2.2.0 GPU training image from AWS Deep Learning Containers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LinuxGpuBuildImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LinuxGpuBuildImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IBuildImage	awsDeepLearningContainersImage(String repositoryName, String tag) (experimental) Returns a Linux GPU build image from AWS Deep Learning Containers.
static IBuildImage	awsDeepLearningContainersImage(String repositoryName, String tag, String account) (experimental) Returns a Linux GPU build image from AWS Deep Learning Containers.
BuildImageConfig	bind(software.constructs.Construct scope, IProject project, BuildImageBindOptions _options) (experimental) Function that allows the build image access to the construct tree.
ComputeType	getDefaultComputeType() (experimental) The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.
String	getImageId() (experimental) The Docker image identifier that the build environment uses.
ImagePullPrincipalType	getImagePullPrincipalType() (experimental) The type of principal that CodeBuild will use to pull this build Docker image.
String	getType() (experimental) The type of build environment.
BuildSpec	runScriptBuildspec(String entrypoint) (experimental) Make a buildspec to run the indicated script.
List<String>	validate(BuildEnvironment buildEnvironment) (experimental) Allows the image a chance to validate whether the passed configuration is correct.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.codebuild.IBuildImage

getRepository, getSecretsManagerCredentials

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

DLC_MXNET_1_4_1

@Stability(value=Experimental)
public static final IBuildImage DLC_MXNET_1_4_1

(experimental) MXNet 1.4.1 GPU image from AWS Deep Learning Containers.

DLC_MXNET_1_6_0

@Stability(value=Experimental)
public static final IBuildImage DLC_MXNET_1_6_0

(experimental) MXNet 1.6.0 GPU image from AWS Deep Learning Containers.

DLC_PYTORCH_1_2_0

@Stability(value=Experimental)
public static final IBuildImage DLC_PYTORCH_1_2_0

(experimental) PyTorch 1.2.0 GPU image from AWS Deep Learning Containers.

DLC_PYTORCH_1_3_1

@Stability(value=Experimental)
public static final IBuildImage DLC_PYTORCH_1_3_1

(experimental) PyTorch 1.3.1 GPU image from AWS Deep Learning Containers.

DLC_PYTORCH_1_4_0_INFERENCE

@Stability(value=Experimental)
public static final IBuildImage DLC_PYTORCH_1_4_0_INFERENCE

(experimental) PyTorch 1.4.0 GPU inference image from AWS Deep Learning Containers.

DLC_PYTORCH_1_4_0_TRAINING

@Stability(value=Experimental)
public static final IBuildImage DLC_PYTORCH_1_4_0_TRAINING

(experimental) PyTorch 1.4.0 GPU training image from AWS Deep Learning Containers.

DLC_PYTORCH_1_5_0_INFERENCE

@Stability(value=Experimental)
public static final IBuildImage DLC_PYTORCH_1_5_0_INFERENCE

(experimental) PyTorch 1.5.0 GPU inference image from AWS Deep Learning Containers.

DLC_PYTORCH_1_5_0_TRAINING

@Stability(value=Experimental)
public static final IBuildImage DLC_PYTORCH_1_5_0_TRAINING

(experimental) PyTorch 1.5.0 GPU training image from AWS Deep Learning Containers.

DLC_TENSORFLOW_1_14_0

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_1_14_0

(experimental) Tensorflow 1.14.0 GPU image from AWS Deep Learning Containers.

DLC_TENSORFLOW_1_15_0

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_1_15_0

(experimental) Tensorflow 1.15.0 GPU image from AWS Deep Learning Containers.

DLC_TENSORFLOW_1_15_2_INFERENCE

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_1_15_2_INFERENCE

(experimental) Tensorflow 1.15.2 GPU inference image from AWS Deep Learning Containers.

DLC_TENSORFLOW_1_15_2_TRAINING

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_1_15_2_TRAINING

(experimental) Tensorflow 1.15.2 GPU training image from AWS Deep Learning Containers.

DLC_TENSORFLOW_2_0_0

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_2_0_0

(experimental) Tensorflow 2.0.0 GPU image from AWS Deep Learning Containers.

DLC_TENSORFLOW_2_0_1

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_2_0_1

(experimental) Tensorflow 2.0.1 GPU image from AWS Deep Learning Containers.

DLC_TENSORFLOW_2_1_0_INFERENCE

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_2_1_0_INFERENCE

(experimental) Tensorflow 2.1.0 GPU inference image from AWS Deep Learning Containers.

DLC_TENSORFLOW_2_1_0_TRAINING

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_2_1_0_TRAINING

(experimental) Tensorflow 2.1.0 GPU training image from AWS Deep Learning Containers.

DLC_TENSORFLOW_2_2_0_TRAINING

@Stability(value=Experimental)
public static final IBuildImage DLC_TENSORFLOW_2_2_0_TRAINING

(experimental) Tensorflow 2.2.0 GPU training image from AWS Deep Learning Containers.

Constructor Detail

LinuxGpuBuildImage

protected LinuxGpuBuildImage(software.amazon.jsii.JsiiObjectRef objRef)

LinuxGpuBuildImage

protected LinuxGpuBuildImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

awsDeepLearningContainersImage

@Stability(value=Experimental)
 @NotNull
public static IBuildImage awsDeepLearningContainersImage(@NotNull
                                                                                                  String repositoryName,
                                                                                                  @NotNull
                                                                                                  String tag,
                                                                                                  @Nullable
                                                                                                  String account)

(experimental) Returns a Linux GPU build image from AWS Deep Learning Containers.

Parameters:

repositoryName - the name of the repository, for example "pytorch-inference". This parameter is required.

tag - the tag of the image, for example "1.5.0-gpu-py36-cu101-ubuntu16.04". This parameter is required.

account - the AWS account ID where the DLC repository for this region is hosted in.

See Also:

https://aws.amazon.com/releasenotes/available-deep-learning-containers-images

awsDeepLearningContainersImage

@Stability(value=Experimental)
 @NotNull
public static IBuildImage awsDeepLearningContainersImage(@NotNull
                                                                                                  String repositoryName,
                                                                                                  @NotNull
                                                                                                  String tag)

(experimental) Returns a Linux GPU build image from AWS Deep Learning Containers.

Parameters:

repositoryName - the name of the repository, for example "pytorch-inference". This parameter is required.

tag - the tag of the image, for example "1.5.0-gpu-py36-cu101-ubuntu16.04". This parameter is required.

See Also:

https://aws.amazon.com/releasenotes/available-deep-learning-containers-images

bind

@Stability(value=Experimental)
 @NotNull
public BuildImageConfig bind(@NotNull
                                                                      software.constructs.Construct scope,
                                                                      @NotNull
                                                                      IProject project,
                                                                      @NotNull
                                                                      BuildImageBindOptions _options)

(experimental) Function that allows the build image access to the construct tree.

Specified by:

bind in interface IBindableBuildImage

Parameters:

scope - This parameter is required.

project - This parameter is required.

_options - This parameter is required.

runScriptBuildspec

@Stability(value=Experimental)
 @NotNull
public BuildSpec runScriptBuildspec(@NotNull
                                                                             String entrypoint)

(experimental) Make a buildspec to run the indicated script.

Specified by:

runScriptBuildspec in interface IBuildImage

Parameters:

entrypoint - This parameter is required.

validate

@Stability(value=Experimental)
 @NotNull
public List<String> validate(@NotNull
                                                                      BuildEnvironment buildEnvironment)

(experimental) Allows the image a chance to validate whether the passed configuration is correct.

Specified by:

validate in interface IBuildImage

Parameters:

buildEnvironment - This parameter is required.

getDefaultComputeType

@Stability(value=Experimental)
 @NotNull
public ComputeType getDefaultComputeType()

(experimental) The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.

Specified by:

getDefaultComputeType in interface IBuildImage

getImageId

@Stability(value=Experimental)
 @NotNull
public String getImageId()

(experimental) The Docker image identifier that the build environment uses.

Specified by:

getImageId in interface IBuildImage

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

getType

@Stability(value=Experimental)
 @NotNull
public String getType()

(experimental) The type of build environment.

Specified by:

getType in interface IBuildImage

getImagePullPrincipalType

@Stability(value=Experimental)
 @Nullable
public ImagePullPrincipalType getImagePullPrincipalType()

(experimental) The type of principal that CodeBuild will use to pull this build Docker image.

Specified by:

getImagePullPrincipalType in interface IBuildImage