software.amazon.awscdk.services.stepfunctions.tasks

Class DockerImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.DockerImage

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:00.887Z")
public abstract class DockerImage
extends software.amazon.jsii.JsiiObject

Creates `IDockerImage` instances.

Example:

 SageMakerCreateModel.Builder.create(this, "Sagemaker")
         .modelName("MyModel")
         .primaryContainer(ContainerDefinition.Builder.create()
                 .image(DockerImage.fromJsonExpression(JsonPath.stringAt("$.Model.imageName")))
                 .mode(Mode.SINGLE_MODEL)
                 .modelS3Location(S3Location.fromJsonExpression("$.TrainingJob.ModelArtifacts.S3ModelArtifacts"))
                 .build())
         .build();
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract DockerImageConfig	bind(ISageMakerTask task) Called when the image is used by a SageMaker task.
static DockerImage	fromAsset(software.constructs.Construct scope, java.lang.String id, DockerImageAssetProps props) Reference a Docker image that is provided as an Asset in the current app.
static DockerImage	fromEcrRepository(IRepository repository) Reference a Docker image stored in an ECR repository.
static DockerImage	fromEcrRepository(IRepository repository, java.lang.String tagOrDigest) Reference a Docker image stored in an ECR repository.
static DockerImage	fromJsonExpression(java.lang.String expression) Reference a Docker image which URI is obtained from the task's input.
static DockerImage	fromJsonExpression(java.lang.String expression, java.lang.Boolean allowAnyEcrImagePull) Reference a Docker image which URI is obtained from the task's input.
static DockerImage	fromRegistry(java.lang.String imageUri) Reference a Docker image by it's URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerImage

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

DockerImage

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

DockerImage

protected DockerImage()

Method Detail

fromAsset

public static DockerImage fromAsset(software.constructs.Construct scope,
                                    java.lang.String id,
                                    DockerImageAssetProps props)

Reference a Docker image that is provided as an Asset in the current app.

Parameters:

scope - the scope in which to create the Asset. This parameter is required.

id - the ID for the asset in the construct tree. This parameter is required.

props - the configuration props of the asset. This parameter is required.

fromEcrRepository

public static DockerImage fromEcrRepository(IRepository repository,
                                            java.lang.String tagOrDigest)

Reference a Docker image stored in an ECR repository.

Parameters:

repository - the ECR repository where the image is hosted. This parameter is required.

tagOrDigest - an optional tag or digest (digests must start with `sha256:`).

fromEcrRepository

public static DockerImage fromEcrRepository(IRepository repository)

Reference a Docker image stored in an ECR repository.

Parameters:

repository - the ECR repository where the image is hosted. This parameter is required.

fromJsonExpression

public static DockerImage fromJsonExpression(java.lang.String expression,
                                             java.lang.Boolean allowAnyEcrImagePull)

Reference a Docker image which URI is obtained from the task's input.

Parameters:

expression - the JSON path expression with the task input. This parameter is required.

allowAnyEcrImagePull - whether ECR access should be permitted (set to `false` if the image will never be in ECR).

fromJsonExpression

public static DockerImage fromJsonExpression(java.lang.String expression)

Reference a Docker image which URI is obtained from the task's input.

Parameters:

expression - the JSON path expression with the task input. This parameter is required.

fromRegistry

public static DockerImage fromRegistry(java.lang.String imageUri)

Reference a Docker image by it's URI.

When referencing ECR images, prefer using inEcr.

Parameters:

imageUri - the URI to the docker image. This parameter is required.

bind

public abstract DockerImageConfig bind(ISageMakerTask task)

Called when the image is used by a SageMaker task.

Parameters:

task - This parameter is required.