Documentation
Reference
API
API components
aws.proto

aws.proto

Package: aws.options.gloo.solo.io Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/v1/options/aws/aws.proto

UpstreamSpec

Upstream Spec for AWS Lambda Upstreams AWS Upstreams represent a collection of Lambda Functions for a particular AWS Account (IAM Role or User account) in a particular region

"region": string
"secretRef": .core.solo.io.ResourceRef
"lambdaFunctions": []aws.options.gloo.solo.io.LambdaFunctionSpec
"roleArn": string
"awsAccountId": string
"disableRoleChaining": bool
"destinationOverrides": .aws.options.gloo.solo.io.DestinationSpec
Field Type Description
region string The AWS Region where the desired Lambda Functions exist.
secretRef .core.solo.io.ResourceRef A secret ref to an AWS Secret AWS Secrets can be created with glooctl secret create aws ... If the secret is created manually, it must conform to the following structure: access_key: <aws access key> secret_key: <aws secret key> session_token: <(optional) aws session token>.
lambdaFunctions []aws.options.gloo.solo.io.LambdaFunctionSpec The list of Lambda Functions contained within this region. This list will be automatically populated by K8sGateway if discovery is enabled for AWS Lambda Functions.
roleArn string (Optional): role_arn to use when assuming a role for a given request via STS. If set this role_arn will override the value found in AWS_ROLE_ARN This option will only be respected if STS credentials are enabled. To enable STS credential fetching see Settings.Gloo.AwsOptions in settings.proto.
awsAccountId string (Optional): The AWS Account ID to use while calling if using resource based access.
disableRoleChaining bool Optional override to disable role chaining;.
destinationOverrides .aws.options.gloo.solo.io.DestinationSpec Specifies AWS DestinationSpec configuration overrides for any route targeting this upstream. Note that the route in question must have an AWS DestinationSpec to be affected and this will only set things that are non-falsey as overrides.

LambdaFunctionSpec

Each Lambda Function Spec contains data necessary for K8sGateway to invoke Lambda functions:

  • name of the function
  • qualifier for the function
"logicalName": string
"lambdaFunctionName": string
"qualifier": string
Field Type Description
logicalName string the logical name K8sGatewayshould associate with this function. if left empty, it will default to lambda_function_name+qualifier.
lambdaFunctionName string The Name of the Lambda Function as it appears in the AWS Lambda Portal.
qualifier string The Qualifier for the Lambda Function. Qualifiers act as a kind of version for Lambda Functions. See https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html for more info.

DestinationSpec

Each Lambda Function Spec contains data necessary for K8sGateway to invoke Lambda functions

"logicalName": string
"invocationStyle": .aws.options.gloo.solo.io.DestinationSpec.InvocationStyle
"requestTransformation": bool
"responseTransformation": bool
"unwrapAsAlb": bool
"unwrapAsApiGateway": bool
"wrapAsApiGateway": bool
Field Type Description
logicalName string The Logical Name of the LambdaFunctionSpec to be invoked.
invocationStyle .aws.options.gloo.solo.io.DestinationSpec.InvocationStyle Can be either Sync or Async.
requestTransformation bool Include headers, multi-value headers, querystring, querystring parameters, multi-value querystring parameters, request path, and request method in the event payload sent to aws lambda Only one of requestTransformation or wrapAsApiGateway should be provided.
responseTransformation bool Deprecated. Use unwrapAsApiGateway.
unwrapAsAlb bool Unwrap the response as if the proxy was an ALB. Intended to ease migration when previously using ALB to invoke Lambdas. For further information see below link for the expected format when true. https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html Only one of unwrapAsAlb or unwrapAsApiGateway may be provided.
unwrapAsApiGateway bool Unwrap the response as if the proxy was an AWS API Gateway. Intended to ease migration when previously using API Gateway to invoke Lambdas. Only one of unwrapAsAlb or unwrapAsApiGateway may be provided.
wrapAsApiGateway bool Enterprise-Only Wrap the request into AWS API Gateway event format. Intended to ease migration when previously using API Gateway to invoke Lambdas. Only one of requestTransformation or wrapAsApiGateway should be provided.

InvocationStyle

Name Description
SYNC
ASYNC
als.protobackoff.proto