Class FunctionCode

java.lang.Object
software.amazon.awssdk.services.lambda.model.FunctionCode
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FunctionCode.Builder,FunctionCode>
@Generated("software.amazon.awssdk:codegen") public final class FunctionCode extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FunctionCode.Builder,FunctionCode>

The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image.

See Also:

  • Method Details

    • zipFile

      public final SdkBytes zipFile()

      The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.

      Returns:
      The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.

    • s3Bucket

      public final String s3Bucket()

      An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

      Returns:
      An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

    • s3Key

      public final String s3Key()

      The Amazon S3 key of the deployment package.

      Returns:
      The Amazon S3 key of the deployment package.

    • s3ObjectVersion

      public final String s3ObjectVersion()

      For versioned objects, the version of the deployment package object to use.

      Returns:
      For versioned objects, the version of the deployment package object to use.

    • s3ObjectStorageMode

      public final S3ObjectStorageMode s3ObjectStorageMode()

      Specifies how the deployment package is stored. Use COPY (default) to upload a copy of your deployment package to Lambda. Use REFERENCE to have Lambda reference the deployment package from the specified Amazon S3 bucket.

      If the service returns an enum value that is not available in the current SDK version, s3ObjectStorageMode will return S3ObjectStorageMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3ObjectStorageModeAsString().

      Returns:
      Specifies how the deployment package is stored. Use COPY (default) to upload a copy of your deployment package to Lambda. Use REFERENCE to have Lambda reference the deployment package from the specified Amazon S3 bucket.
      See Also:

    • s3ObjectStorageModeAsString

      public final String s3ObjectStorageModeAsString()

      Specifies how the deployment package is stored. Use COPY (default) to upload a copy of your deployment package to Lambda. Use REFERENCE to have Lambda reference the deployment package from the specified Amazon S3 bucket.

      If the service returns an enum value that is not available in the current SDK version, s3ObjectStorageMode will return S3ObjectStorageMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3ObjectStorageModeAsString().

      Returns:
      Specifies how the deployment package is stored. Use COPY (default) to upload a copy of your deployment package to Lambda. Use REFERENCE to have Lambda reference the deployment package from the specified Amazon S3 bucket.
      See Also:

    • imageUri

      public final String imageUri()

      URI of a container image in the Amazon ECR registry.

      Returns:
      URI of a container image in the Amazon ECR registry.

    • sourceKMSKeyArn

      public final String sourceKMSKeyArn()

      The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

      Returns:
      The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

    • toBuilder

      public FunctionCode.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FunctionCode.Builder,FunctionCode>
      Returns:
      a builder for type T

    • builder

      public static FunctionCode.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FunctionCode.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.