java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.Code

All Implemented Interfaces:: software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:: AssetCode, AssetImageCode, CfnParametersCode, EcrImageCode, InlineCode, S3Code

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.687Z") @Stability(Stable) public abstract class Code extends software.amazon.jsii.JsiiObject

Represents the Lambda Handler Code.

Example:

 import software.amazon.awscdk.services.signer.*;
 SigningProfile signingProfile = SigningProfile.Builder.create(this, "SigningProfile")
         .platform(Platform.AWS_LAMBDA_SHA384_ECDSA)
         .build();
 CodeSigningConfig codeSigningConfig = CodeSigningConfig.Builder.create(this, "CodeSigningConfig")
         .signingProfiles(List.of(signingProfile))
         .build();
 Function.Builder.create(this, "Function")
         .codeSigningConfig(codeSigningConfig)
         .runtime(Runtime.NODEJS_16_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();

Nested Class Summary

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

Constructors

Modifier

Constructor

Description

protected

Code()

protected

Code(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

protected

Code(software.amazon.jsii.JsiiObjectRef objRef)
Method Summary

Modifier and Type

Method

Description

static AssetCode

asset(String path)

Deprecated.
use fromAsset

abstract 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.

static S3Code

bucket(IBucket bucket, String key)

Deprecated.
use fromBucket

static S3Code

bucket(IBucket bucket, String key, String objectVersion)

Deprecated.
use fromBucket

static CfnParametersCode

cfnParameters()

Deprecated.
use fromCfnParameters

static CfnParametersCode

cfnParameters(CfnParametersCodeProps props)

Deprecated.
use fromCfnParameters

static AssetCode

fromAsset(String path)

Loads the function code from a local disk path.

static AssetCode

fromAsset(String path, AssetOptions options)

Loads the function code from a local disk path.

static AssetImageCode

fromAssetImage(String directory)

Create an ECR image from the specified asset and bind it as the Lambda code.

static AssetImageCode

fromAssetImage(String directory, AssetImageCodeProps props)

Create an ECR image from the specified asset and bind it as the Lambda code.

static S3Code

fromBucket(IBucket bucket, String key)

Lambda handler code as an S3 object.

static S3Code

fromBucket(IBucket bucket, String key, String objectVersion)

Lambda handler code as an S3 object.

static CfnParametersCode

fromCfnParameters()

Creates a new Lambda source defined using CloudFormation parameters.

static CfnParametersCode

fromCfnParameters(CfnParametersCodeProps props)

Creates a new Lambda source defined using CloudFormation parameters.

static AssetCode

fromDockerBuild(String path)

Loads the function code from an asset created by a Docker build.

static AssetCode

fromDockerBuild(String path, DockerBuildAssetOptions options)

Loads the function code from an asset created by a Docker build.

static EcrImageCode

fromEcrImage(IRepository repository)

Use an existing ECR image as the Lambda code.

static EcrImageCode

fromEcrImage(IRepository repository, EcrImageCodeProps props)

Use an existing ECR image as the Lambda code.

static InlineCode

fromInline(String code)

Inline code for Lambda handler.

abstract Boolean

getIsInline()

Deprecated.
this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().

static InlineCode

inline(String code)

Deprecated.
use 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 Details
- Code
  
  protected Code(software.amazon.jsii.JsiiObjectRef objRef)
- Code
  
  protected Code(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
- Code
  
  @Stability(Stable) protected Code()
Method Details
- asset
  
  @Stability(Deprecated) @Deprecated @NotNull public static AssetCode asset(@NotNull String path)
  
  Deprecated.
  use fromAsset
  
  (deprecated) DEPRECATED.
  
  Parameters:
  
  path - This parameter is required.
- bucket
  
  @Stability(Deprecated) @Deprecated @NotNull public static S3Code bucket(@NotNull IBucket bucket, @NotNull String key, @Nullable String objectVersion)
  
  Deprecated.
  use fromBucket
  
  (deprecated) DEPRECATED.
  
  Parameters:
  
  bucket - This parameter is required.
  
  key - This parameter is required.
  
  objectVersion -
- bucket
  
  @Stability(Deprecated) @Deprecated @NotNull public static S3Code bucket(@NotNull IBucket bucket, @NotNull String key)
  
  Deprecated.
  use fromBucket
  
  (deprecated) DEPRECATED.
  
  Parameters:
  
  bucket - This parameter is required.
  
  key - This parameter is required.
- cfnParameters
  
  @Stability(Deprecated) @Deprecated @NotNull public static CfnParametersCode cfnParameters(@Nullable CfnParametersCodeProps props)
  
  Deprecated.
  use fromCfnParameters
  
  (deprecated) DEPRECATED.
  
  Parameters:
  
  props -
- cfnParameters
  
  @Stability(Deprecated) @Deprecated @NotNull public static CfnParametersCode cfnParameters()
  
  Deprecated.
  use fromCfnParameters
  
  (deprecated) DEPRECATED.
- fromAsset
  
  @Stability(Stable) @NotNull public static AssetCode fromAsset(@NotNull String path, @Nullable AssetOptions options)
  
  Loads the function code from a local disk path.
  
  Parameters:
  
  path - Either a directory with the Lambda code bundle or a .zip file. This parameter is required.
  
  options -
- fromAsset
  
  @Stability(Stable) @NotNull public static AssetCode fromAsset(@NotNull String path)
  
  Loads the function code from a local disk path.
  
  Parameters:
  
  path - Either a directory with the Lambda code bundle or a .zip file. This parameter is required.
- fromAssetImage
  
  @Stability(Stable) @NotNull public static AssetImageCode fromAssetImage(@NotNull String directory, @Nullable AssetImageCodeProps props)
  
  Create an ECR image from the specified asset and bind it as the Lambda code.
  
  Parameters:
  
  directory - the directory from which the asset must be created. This parameter is required.
  
  props - properties to further configure the selected image.
- fromAssetImage
  
  @Stability(Stable) @NotNull public static AssetImageCode fromAssetImage(@NotNull String directory)
  
  Create an ECR image from the specified asset and bind it as the Lambda code.
  
  Parameters:
  
  directory - the directory from which the asset must be created. This parameter is required.
- fromBucket
  
  @Stability(Stable) @NotNull public static S3Code fromBucket(@NotNull IBucket bucket, @NotNull String key, @Nullable String objectVersion)
  
  Lambda handler code as an S3 object.
  
  Parameters:
  
  bucket - The S3 bucket. This parameter is required.
  
  key - The object key. This parameter is required.
  
  objectVersion - Optional S3 object version.
- fromBucket
  
  @Stability(Stable) @NotNull public static S3Code fromBucket(@NotNull IBucket bucket, @NotNull String key)
  
  Lambda handler code as an S3 object.
  
  Parameters:
  
  bucket - The S3 bucket. This parameter is required.
  
  key - The object key. This parameter is required.
- fromCfnParameters
  
  @Stability(Stable) @NotNull public static CfnParametersCode fromCfnParameters(@Nullable CfnParametersCodeProps props)
  
  Creates a new Lambda source defined using CloudFormation parameters.
  
  Parameters:
  
  props - optional construction properties of CfnParametersCode.
  
  Returns:
  
  a new instance of CfnParametersCode
- fromCfnParameters
  
  @Stability(Stable) @NotNull public static CfnParametersCode fromCfnParameters()
  
  Creates a new Lambda source defined using CloudFormation parameters.
  
  Returns:
  
  a new instance of CfnParametersCode
- fromDockerBuild
  
  @Stability(Stable) @NotNull public static AssetCode fromDockerBuild(@NotNull String path, @Nullable DockerBuildAssetOptions options)
  
  Loads the function code from an asset created by a Docker build.
  By default, the asset is expected to be located at /asset in the image.
  
  Parameters:
  
  path - The path to the directory containing the Docker file. This parameter is required.
  
  options - Docker build options.
- fromDockerBuild
  
  @Stability(Stable) @NotNull public static AssetCode fromDockerBuild(@NotNull String path)
  
  Loads the function code from an asset created by a Docker build.
  By default, the asset is expected to be located at /asset in the image.
  
  Parameters:
  
  path - The path to the directory containing the Docker file. This parameter is required.
- fromEcrImage
  
  @Stability(Stable) @NotNull public static EcrImageCode fromEcrImage(@NotNull IRepository repository, @Nullable EcrImageCodeProps props)
  
  Use an existing ECR image as the Lambda code.
  
  Parameters:
  
  repository - the ECR repository that the image is in. This parameter is required.
  
  props - properties to further configure the selected image.
- fromEcrImage
  
  @Stability(Stable) @NotNull public static EcrImageCode fromEcrImage(@NotNull IRepository repository)
  
  Use an existing ECR image as the Lambda code.
  
  Parameters:
  
  repository - the ECR repository that the image is in. This parameter is required.
- fromInline
  
  @Stability(Stable) @NotNull public static InlineCode fromInline(@NotNull String code)
  
  Inline code for Lambda handler.
  
  Parameters:
  
  code - The actual handler code (limited to 4KiB). This parameter is required.
  
  Returns:
  
  LambdaInlineCode with inline code.
- inline
  
  @Stability(Deprecated) @Deprecated @NotNull public static InlineCode inline(@NotNull String code)
  
  Deprecated.
  use fromInline
  
  (deprecated) DEPRECATED.
  
  Parameters:
  
  code - This parameter is required.
- bind
  
  @Stability(Stable) @NotNull public abstract CodeConfig bind(@NotNull Construct scope)
  
  Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun.
  
  Parameters:
  
  scope - The binding scope. This parameter is required.
- bindToResource
  
  @Stability(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.
  
  Parameters:
  
  _resource - This parameter is required.
  
  _options -
- bindToResource
  
  @Stability(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.
  
  Parameters:
  
  _resource - This parameter is required.
- getIsInline
  
  @Stability(Deprecated) @Deprecated @NotNull public abstract Boolean getIsInline()
  
  Deprecated.
  this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().
  
  (deprecated) Determines whether this Code is inline code or not.

Class Code

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Details

Code

Code

Code

Method Details

asset

bucket

bucket

cfnParameters

cfnParameters

fromAsset

fromAsset

fromAssetImage

fromAssetImage

fromBucket

fromBucket

fromCfnParameters

fromCfnParameters

fromDockerBuild

fromDockerBuild

fromEcrImage

fromEcrImage

fromInline

inline

bind

bindToResource

bindToResource

getIsInline