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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:44.015Z")
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.assets.*;
 import software.amazon.awscdk.services.ecr.assets.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.core.*;
 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")
         .follow(FollowMode.NEVER)
         .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)
         .repositoryName("repositoryName")
         .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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CodeConfig	bind(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.
java.lang.Boolean	getIsInline() Determines whether this Code is inline code or not.

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

asset, bucket, bucket, cfnParameters, cfnParameters, fromAsset, fromAsset, fromAssetImage, fromAssetImage, fromBucket, fromBucket, fromCfnParameters, fromCfnParameters, fromDockerBuild, fromDockerBuild, fromEcrImage, fromEcrImage, fromInline, inline

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetImageCode

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

AssetImageCode

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

AssetImageCode

public AssetImageCode(java.lang.String directory,
                      AssetImageCodeProps props)

Parameters:

directory - This parameter is required.

props - This parameter is required.

Method Detail

bind

public CodeConfig bind(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

public void bindToResource(CfnResource resource,
                           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

public void bindToResource(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

public java.lang.Boolean getIsInline()

Determines whether this Code is inline code or not.

Specified by:

getIsInline in class Code