Package com.commercetools.api.models.extension

Interface AWSLambdaDestination

All Superinterfaces:
ExtensionDestination
All Known Subinterfaces:
ExtensionAWSLambdaDestination
All Known Implementing Classes:
AWSLambdaDestinationImpl
public interface AWSLambdaDestination extends ExtensionDestination

We recommend creating an Identify and Access Management (IAM) user with an accessKey and accessSecret pair, specifically for each Extension that only has the lambda:InvokeFunction permission on this function.

Example to create an instance using the builder pattern 

     AWSLambdaDestination aWSLambdaDestination = AWSLambdaDestination.builder()
             .arn("{arn}")
             .accessKey("{accessKey}")
             .accessSecret("{accessSecret}")
             .build()

  • Field Details

  • Method Details

    • getArn

      @NotNull @NotNull String getArn()

      Amazon Resource Name (ARN) of the Lambda function in the format arn:aws:lambda:<region>:<accountid>:function:<functionName>. Use the format arn:aws:lambda:<region>:<accountid>:function:<functionName>:<functionAlias/version> to point to a specific version of the function.

      Returns:
      arn

    • getAccessKey

      @NotNull @NotNull String getAccessKey()

      Partially hidden on retrieval for security reasons.

      Returns:
      accessKey

    • getAccessSecret

      @NotNull @NotNull String getAccessSecret()

      Partially hidden on retrieval for security reasons.

      Returns:
      accessSecret

    • setArn

      void setArn(String arn)

      Amazon Resource Name (ARN) of the Lambda function in the format arn:aws:lambda:<region>:<accountid>:function:<functionName>. Use the format arn:aws:lambda:<region>:<accountid>:function:<functionName>:<functionAlias/version> to point to a specific version of the function.

      Parameters:
      arn - value to be set

    • setAccessKey

      void setAccessKey(String accessKey)

      Partially hidden on retrieval for security reasons.

      Parameters:
      accessKey - value to be set

    • setAccessSecret

      void setAccessSecret(String accessSecret)

      Partially hidden on retrieval for security reasons.

      Parameters:
      accessSecret - value to be set

    • of

      static AWSLambdaDestination of()
      factory method
      Returns:
      instance of AWSLambdaDestination

    • of

      static AWSLambdaDestination of(AWSLambdaDestination template)
      factory method to create a shallow copy AWSLambdaDestination
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static AWSLambdaDestination deepCopy(@Nullable AWSLambdaDestination template)
      factory method to create a deep copy of AWSLambdaDestination
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static AWSLambdaDestinationBuilder builder()
      builder factory method for AWSLambdaDestination
      Returns:
      builder

    • builder

      static AWSLambdaDestinationBuilder builder(AWSLambdaDestination template)
      create builder for AWSLambdaDestination instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withAWSLambdaDestination

      default <T> T withAWSLambdaDestination(Function<AWSLambdaDestination,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<AWSLambdaDestination> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference