Cloud.Service.AWS.Lambda.Event.Source.Mapping

JSON Example

{
    "account": "string",
    "batch_size": 0,
    "count": 0,
    "enabled": false,
    "event_source_arn": "string",
    "function_arn": "string",
    "function_name": "string",
    "last_modified": "string",
    "last_processing_result": "string",
    "region": "string",
    "starting_position": "string",
    "starting_position_timestamp": "string",
    "state": "string",
    "state_transition_reason": "string",
    "uuid": "string"
}

string

account

Required

(Required) The name of the AWS cloud account to use for this resource

integer

batch_size

Optional

Maximum number of records that Lambda can retrieve from the event source upon invocation. Range is 1 to 10,000. Default is 100 for DynamoDB and Kinesis, 10 for SQS.

integer

count

Optional

The number of resource instances to be created.

boolean

enabled

Optional

Whether the mapping is enabled upon creation. Default is true.

string

event_source_arn

Required

(Required) The Amazon Resource Name (ARN) of the event source in format: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)

Amazon Kinesis - ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams - ARN of the stream.
Amazon Simple Queue Service - ARN of the queue.

string

function_arn

Optional

ARN of the Lambda function that the event source mapping is sending events to. A computed value that differs from function_name.

string

function_name

Required

(Required) ARN of the Lambda function that subscribes to events.

string

last_modified

Optional

Date when the mapping was last modified.

string

last_processing_result

Optional

Outcome from the last invocation of the Lambda function.

string

region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

string

starting_position

Optional

Stream position where AWS Lambda starts reading. When getting events from Kinesis or DynamoDB, must be TRIM_HORIZON or LATEST. Do not provide when getting events from SQS.

string

starting_position_timestamp

Optional

Date at which the function starts processing records.

string

state

Optional

The state of the event source mapping: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

string

state_transition_reason

Optional

Cause of the last state change: User initiated or Lambda initiated.

string

uuid

Optional

Universally unique identifier assigned by AWS to the event source mapping.