Interface CodeConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CodeConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-03-01T20:58:26.508Z") @Stability(Stable) public interface CodeConfig extends software.amazon.jsii.JsiiSerializable
Result of binding Code into a Function.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CodeConfig codeConfig = CodeConfig.builder()
         .image(CodeImageConfig.builder()
                 .imageUri("imageUri")
                 // the properties below are optional
                 .cmd(List.of("cmd"))
                 .entrypoint(List.of("entrypoint"))
                 .workingDirectory("workingDirectory")
                 .build())
         .inlineCode("inlineCode")
         .s3Location(Location.builder()
                 .bucketName("bucketName")
                 .objectKey("objectKey")
                 // the properties below are optional
                 .objectVersion("objectVersion")
                 .build())
         .build();
 
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for CodeConfig
    static final class 
    An implementation for CodeConfig
  • Method Summary

    Modifier and Type
    Method
    Description
     
    Docker image configuration (mutually exclusive with s3Location and inlineCode).
    default String
    Inline code (mutually exclusive with s3Location and image).
    default Location
    The location of the code in S3 (mutually exclusive with inlineCode and image).

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getImage

      @Stability(Stable) @Nullable default CodeImageConfig getImage()
      Docker image configuration (mutually exclusive with s3Location and inlineCode).

      Default: - code is not an ECR container image

    • getInlineCode

      @Stability(Stable) @Nullable default String getInlineCode()
      Inline code (mutually exclusive with s3Location and image).

      Default: - code is not inline code

    • getS3Location

      @Stability(Stable) @Nullable default Location getS3Location()
      The location of the code in S3 (mutually exclusive with inlineCode and image).

      Default: - code is not an s3 location

    • builder

      @Stability(Stable) static CodeConfig.Builder builder()
      Returns:
      a CodeConfig.Builder of CodeConfig