Package io.envoyproxy.envoy.extensions.filters.http.aws_lambda.v3

Interface ConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Config, Config.Builder
public interface ConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArn()
    The ARN of the AWS Lambda to invoke when the filter is engaged Must be in the following format: arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
    com.google.protobuf.ByteString
    getArnBytes()
    The ARN of the AWS Lambda to invoke when the filter is engaged Must be in the following format: arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
    Credentials
    getCredentials()
    Specifies the credentials to be used.
    CredentialsOrBuilder
    getCredentialsOrBuilder()
    Specifies the credentials to be used.
    String
    getCredentialsProfile()
    Specifies the credentials profile to be used from the AWS credentials file.
    com.google.protobuf.ByteString
    getCredentialsProfileBytes()
    Specifies the credentials profile to be used from the AWS credentials file.
    String
    getHostRewrite()
    Indicates that before signing headers, the host header will be swapped with this value.
    com.google.protobuf.ByteString
    getHostRewriteBytes()
    Indicates that before signing headers, the host header will be swapped with this value.
    Config.InvocationMode
    getInvocationMode()
    Determines the way to invoke the Lambda function.
    int
    getInvocationModeValue()
    Determines the way to invoke the Lambda function.
    boolean
    getPayloadPassthrough()
    Whether to transform the request (headers and body) to a JSON payload or pass it as is.
    boolean
    hasCredentials()
    Specifies the credentials to be used.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getArn

      String getArn()
       The ARN of the AWS Lambda to invoke when the filter is engaged
 Must be in the following format:
 arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
      string arn = 1 [(.validate.rules) = { ... }
      Returns:
      The arn.

    • getArnBytes

      com.google.protobuf.ByteString getArnBytes()
       The ARN of the AWS Lambda to invoke when the filter is engaged
 Must be in the following format:
 arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
      string arn = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for arn.

    • getPayloadPassthrough

      boolean getPayloadPassthrough()
       Whether to transform the request (headers and body) to a JSON payload or pass it as is.
      bool payload_passthrough = 2;
      Returns:
      The payloadPassthrough.

    • getInvocationModeValue

      int getInvocationModeValue()
       Determines the way to invoke the Lambda function.
      .envoy.extensions.filters.http.aws_lambda.v3.Config.InvocationMode invocation_mode = 3 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for invocationMode.

    • getInvocationMode

      Config.InvocationMode getInvocationMode()
       Determines the way to invoke the Lambda function.
      .envoy.extensions.filters.http.aws_lambda.v3.Config.InvocationMode invocation_mode = 3 [(.validate.rules) = { ... }
      Returns:
      The invocationMode.

    • getHostRewrite

      String getHostRewrite()
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.

     Changing the value of the host header can result in a different route to be selected
     if an HTTP filter after AWS lambda re-evaluates the route (clears route cache).
      string host_rewrite = 4;
      Returns:
      The hostRewrite.

    • getHostRewriteBytes

      com.google.protobuf.ByteString getHostRewriteBytes()
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.

     Changing the value of the host header can result in a different route to be selected
     if an HTTP filter after AWS lambda re-evaluates the route (clears route cache).
      string host_rewrite = 4;
      Returns:
      The bytes for hostRewrite.

    • getCredentialsProfile

      String getCredentialsProfile()
       Specifies the credentials profile to be used from the AWS credentials file.
 This parameter is optional. If set, it will override the value set in the AWS_PROFILE env variable and
 the provider chain is limited to the AWS credentials file Provider.
 If credentials configuration is provided, this configuration will be ignored.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).
      string credentials_profile = 5;
      Returns:
      The credentialsProfile.

    • getCredentialsProfileBytes

      com.google.protobuf.ByteString getCredentialsProfileBytes()
       Specifies the credentials profile to be used from the AWS credentials file.
 This parameter is optional. If set, it will override the value set in the AWS_PROFILE env variable and
 the provider chain is limited to the AWS credentials file Provider.
 If credentials configuration is provided, this configuration will be ignored.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).
      string credentials_profile = 5;
      Returns:
      The bytes for credentialsProfile.

    • hasCredentials

      boolean hasCredentials()
       Specifies the credentials to be used. This parameter is optional and if it is set,
 it will override other providers and will take precedence over credentials_profile.
 The provider chain is limited to the configuration credentials provider.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).

 .. warning::
   Distributing the AWS credentials via this configuration should not be done in production.
      .envoy.extensions.filters.http.aws_lambda.v3.Credentials credentials = 6;
      Returns:
      Whether the credentials field is set.

    • getCredentials

      Credentials getCredentials()
       Specifies the credentials to be used. This parameter is optional and if it is set,
 it will override other providers and will take precedence over credentials_profile.
 The provider chain is limited to the configuration credentials provider.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).

 .. warning::
   Distributing the AWS credentials via this configuration should not be done in production.
      .envoy.extensions.filters.http.aws_lambda.v3.Credentials credentials = 6;
      Returns:
      The credentials.

    • getCredentialsOrBuilder

      CredentialsOrBuilder getCredentialsOrBuilder()
       Specifies the credentials to be used. This parameter is optional and if it is set,
 it will override other providers and will take precedence over credentials_profile.
 The provider chain is limited to the configuration credentials provider.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).

 .. warning::
   Distributing the AWS credentials via this configuration should not be done in production.
      .envoy.extensions.filters.http.aws_lambda.v3.Credentials credentials = 6;