software.amazon.awscdk.services.lambda

Class AssetImageCode

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.Code

software.amazon.awscdk.services.lambda.AssetImageCode

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.377Z")
 @Stability(value=Stable)
public class AssetImageCode
extends Code

Represents an ECR image that will be constructed from the specified asset and can be bound as Lambda code.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ecr.assets.*;
 import software.amazon.awscdk.services.lambda.*;
 NetworkMode networkMode;
 Platform platform;
 AssetImageCode assetImageCode = AssetImageCode.Builder.create("directory")
         .buildArgs(Map.of(
                 "buildArgsKey", "buildArgs"))
         .cmd(List.of("cmd"))
         .entrypoint(List.of("entrypoint"))
         .exclude(List.of("exclude"))
         .extraHash("extraHash")
         .file("file")
         .followSymlinks(SymlinkFollowMode.NEVER)
         .ignoreMode(IgnoreMode.GLOB)
         .invalidation(DockerImageAssetInvalidationOptions.builder()
                 .buildArgs(false)
                 .extraHash(false)
                 .file(false)
                 .networkMode(false)
                 .platform(false)
                 .repositoryName(false)
                 .target(false)
                 .build())
         .networkMode(networkMode)
         .platform(platform)
         .target("target")
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetImageCode.Builder A fluent builder for AssetImageCode.

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetImageCode(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AssetImageCode(software.amazon.jsii.JsiiObjectRef objRef)
	AssetImageCode(String directory, AssetImageCodeProps props)

Method Summary

Modifier and Type	Method and Description
CodeConfig	bind(software.constructs.Construct scope) Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun.
void	bindToResource(CfnResource resource) Called after the CFN function resource has been created to allow the code class to bind to it.
void	bindToResource(CfnResource resource, ResourceBindOptions options) Called after the CFN function resource has been created to allow the code class to bind to it.
Boolean	getIsInline() Determines whether this Code is inline code or not.

Methods inherited from class software.amazon.awscdk.services.lambda.Code

fromAsset, fromAsset, fromAssetImage, fromAssetImage, fromBucket, fromBucket, fromCfnParameters, fromCfnParameters, fromDockerBuild, fromDockerBuild, fromEcrImage, fromEcrImage, fromInline

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.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AssetImageCode

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

AssetImageCode

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

AssetImageCode

@Stability(value=Stable)
public AssetImageCode(@NotNull
                                               String directory,
                                               @NotNull
                                               AssetImageCodeProps props)

Parameters:

directory - This parameter is required.

props - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public CodeConfig bind(@NotNull
                                                          software.constructs.Construct scope)

Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun.

Specified by:

bind in class Code

Parameters:

scope - This parameter is required.

bindToResource

@Stability(value=Stable)
public void bindToResource(@NotNull
                                                    CfnResource resource,
                                                    @Nullable
                                                    ResourceBindOptions options)

Called after the CFN function resource has been created to allow the code class to bind to it.

Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.

Overrides:

bindToResource in class Code

Parameters:

resource - This parameter is required.

options -

bindToResource

@Stability(value=Stable)
public void bindToResource(@NotNull
                                                    CfnResource resource)

Called after the CFN function resource has been created to allow the code class to bind to it.

Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.

Overrides:

bindToResource in class Code

Parameters:

resource - This parameter is required.

getIsInline

@Stability(value=Stable)
 @NotNull
public Boolean getIsInline()

Determines whether this Code is inline code or not.