software.amazon.awscdk.services.stepfunctions.tasks

Class DockerImage

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.13.3 (build 3624e0f)",
           date="2019-07-04T19:44:32.558Z")
 @Stability(value=Experimental)
public abstract class DockerImage
extends software.amazon.jsii.JsiiObject

Creates `IDockerImage` instances. EXPERIMENTAL

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	DockerImage()
protected	DockerImage(software.amazon.jsii.JsiiObject.InitializationMode mode)

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.amazon.awscdk.core.Construct scope, String id, software.amazon.awscdk.services.ecr.assets.DockerImageAssetProps props) Reference a Docker image that is provided as an Asset in the current app.
static DockerImage	fromEcrRepository(software.amazon.awscdk.services.ecr.IRepository repository) Reference a Docker image stored in an ECR repository.
static DockerImage	fromEcrRepository(software.amazon.awscdk.services.ecr.IRepository repository, String tag) Reference a Docker image stored in an ECR repository.
static DockerImage	fromJsonExpression(String expression) Reference a Docker image which URI is obtained from the task's input.
static DockerImage	fromJsonExpression(String expression, Boolean allowAnyEcrImagePull) Reference a Docker image which URI is obtained from the task's input.
static DockerImage	fromRegistry(String imageUri) Reference a Docker image by it's URI.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DockerImage

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

DockerImage

public DockerImage()

Method Detail

fromAsset

@Stability(value=Experimental)
public static DockerImage fromAsset(software.amazon.awscdk.core.Construct scope,
                                                                   String id,
                                                                   software.amazon.awscdk.services.ecr.assets.DockerImageAssetProps props)

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

Parameters:

scope - the scope in which to create the Asset.

id - the ID for the asset in the construct tree.

props - the configuration props of the asset.

fromEcrRepository

@Stability(value=Experimental)
public static DockerImage fromEcrRepository(software.amazon.awscdk.services.ecr.IRepository repository,
                                                                           @Nullable
                                                                           String tag)

Reference a Docker image stored in an ECR repository. EXPERIMENTAL

Parameters:

repository - the ECR repository where the image is hosted.

tag - an optional `tag`.

fromEcrRepository

@Stability(value=Experimental)
public static DockerImage fromEcrRepository(software.amazon.awscdk.services.ecr.IRepository repository)

Reference a Docker image stored in an ECR repository. EXPERIMENTAL

Parameters:

repository - the ECR repository where the image is hosted.

fromJsonExpression

@Stability(value=Experimental)
public static DockerImage fromJsonExpression(String expression,
                                                                            @Nullable
                                                                            Boolean allowAnyEcrImagePull)

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

Parameters:

expression - the JSON path expression with the task input.

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

fromJsonExpression

@Stability(value=Experimental)
public static DockerImage fromJsonExpression(String expression)

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

Parameters:

expression - the JSON path expression with the task input.

fromRegistry

@Stability(value=Experimental)
public static DockerImage fromRegistry(String imageUri)

Reference a Docker image by it's URI. When referencing ECR images, prefer using `inEcr`. EXPERIMENTAL

Parameters:

imageUri - the URI to the docker image.

bind

@Stability(value=Experimental)
public abstract DockerImageConfig bind(ISageMakerTask task)

Called when the image is used by a SageMaker task. EXPERIMENTAL