eventsourcemapping_v1alpha1.json

{
  "description": "EventSourceMapping is the Schema for the EventSourceMappings API",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "EventSourceMappingSpec defines the desired state of EventSourceMapping.",
      "properties": {
        "amazonManagedKafkaEventSourceConfig": {
          "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.",
          "properties": {
            "consumerGroupID": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "batchSize": {
          "description": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). \n - Amazon Kinesis \u2013 Default 100. Max 10,000. \n - Amazon DynamoDB Streams \u2013 Default 100. Max 10,000. \n - Amazon Simple Queue Service \u2013 Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. \n - Amazon Managed Streaming for Apache Kafka \u2013 Default 100. Max 10,000. \n - Self-managed Apache Kafka \u2013 Default 100. Max 10,000. \n - Amazon MQ (ActiveMQ and RabbitMQ) \u2013 Default 100. Max 10,000.",
          "format": "int64",
          "type": "integer"
        },
        "bisectBatchOnFunctionError": {
          "description": "(Streams only) If the function returns an error, split the batch in two and retry.",
          "type": "boolean"
        },
        "destinationConfig": {
          "description": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.",
          "properties": {
            "onFailure": {
              "description": "A destination for events that failed processing.",
              "properties": {
                "destination": {
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            },
            "onSuccess": {
              "description": "A destination for events that were processed successfully.",
              "properties": {
                "destination": {
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "enabled": {
          "description": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation. \n Default: True",
          "type": "boolean"
        },
        "eventSourceARN": {
          "description": "The Amazon Resource Name (ARN) of the event source. \n - Amazon Kinesis \u2013 The ARN of the data stream or a stream consumer. \n - Amazon DynamoDB Streams \u2013 The ARN of the stream. \n - Amazon Simple Queue Service \u2013 The ARN of the queue. \n - Amazon Managed Streaming for Apache Kafka \u2013 The ARN of the cluster. \n - Amazon MQ \u2013 The ARN of the broker.",
          "type": "string"
        },
        "filterCriteria": {
          "description": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).",
          "properties": {
            "filters": {
              "items": {
                "description": "A structure within a FilterCriteria object that defines an event filtering pattern.",
                "properties": {
                  "pattern": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "functionName": {
          "description": "The name of the Lambda function. \n Name formats \n - Function name \u2013 MyFunction. \n - Function ARN \u2013 arn:aws:lambda:us-west-2:123456789012:function:MyFunction. \n - Version or Alias ARN \u2013 arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD. \n - Partial ARN \u2013 123456789012:function:MyFunction. \n The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.",
          "type": "string"
        },
        "functionRef": {
          "description": "AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using 'from' field Ex: APIIDRef: \n from: name: my-api",
          "properties": {
            "from": {
              "description": "AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)",
              "properties": {
                "name": {
                  "type": "string"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "functionResponseTypes": {
          "description": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "maximumBatchingWindowInSeconds": {
          "description": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds. \n For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping. \n Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.",
          "format": "int64",
          "type": "integer"
        },
        "maximumRecordAgeInSeconds": {
          "description": "(Streams only) Discard records older than the specified age. The default value is infinite (-1).",
          "format": "int64",
          "type": "integer"
        },
        "maximumRetryAttempts": {
          "description": "(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.",
          "format": "int64",
          "type": "integer"
        },
        "parallelizationFactor": {
          "description": "(Streams only) The number of batches to process from each shard concurrently.",
          "format": "int64",
          "type": "integer"
        },
        "queueRefs": {
          "items": {
            "description": "AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using 'from' field Ex: APIIDRef: \n from: name: my-api",
            "properties": {
              "from": {
                "description": "AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)",
                "properties": {
                  "name": {
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "queues": {
          "description": "(MQ) The name of the Amazon MQ broker destination queue to consume.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "scalingConfig": {
          "description": "(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).",
          "properties": {
            "maximumConcurrency": {
              "format": "int64",
              "type": "integer"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "selfManagedEventSource": {
          "description": "The self-managed Apache Kafka cluster to receive records from.",
          "properties": {
            "endpoints": {
              "additionalProperties": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "type": "object"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "selfManagedKafkaEventSourceConfig": {
          "description": "Specific configuration settings for a self-managed Apache Kafka event source.",
          "properties": {
            "consumerGroupID": {
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "sourceAccessConfigurations": {
          "description": "An array of authentication protocols or VPC components required to secure your event source.",
          "items": {
            "description": "To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.",
            "properties": {
              "type_": {
                "type": "string"
              },
              "uRI": {
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "startingPosition": {
          "description": "The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.",
          "type": "string"
        },
        "startingPositionTimestamp": {
          "description": "With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.",
          "format": "date-time",
          "type": "string"
        },
        "topics": {
          "description": "The name of the Kafka topic.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "tumblingWindowInSeconds": {
          "description": "(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.",
          "format": "int64",
          "type": "integer"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "EventSourceMappingStatus defines the observed state of EventSourceMapping",
      "properties": {
        "ackResourceMetadata": {
          "description": "All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource",
          "properties": {
            "arn": {
              "description": "ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \"adopted\" resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR's Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270",
              "type": "string"
            },
            "ownerAccountID": {
              "description": "OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.",
              "type": "string"
            },
            "region": {
              "description": "Region is the AWS region in which the resource exists or will exist.",
              "type": "string"
            }
          },
          "required": [
            "ownerAccountID",
            "region"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "conditions": {
          "description": "All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource",
          "items": {
            "description": "Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states  of the CR and its backend AWS service API resource",
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "A human readable message indicating details about the transition.",
                "type": "string"
              },
              "reason": {
                "description": "The reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status of the condition, one of True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the Condition",
                "type": "string"
              }
            },
            "required": [
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "functionARN": {
          "description": "The ARN of the Lambda function.",
          "type": "string"
        },
        "lastModified": {
          "description": "The date that the event source mapping was last updated or that its state changed.",
          "format": "date-time",
          "type": "string"
        },
        "lastProcessingResult": {
          "description": "The result of the last Lambda invocation of your function.",
          "type": "string"
        },
        "state": {
          "description": "The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.",
          "type": "string"
        },
        "stateTransitionReason": {
          "description": "Indicates whether a user or Lambda made the last change to the event source mapping.",
          "type": "string"
        },
        "uuid": {
          "description": "The identifier of the event source mapping.",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}