AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::LambdaPreview::Types::EventSourceConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes mapping between an Amazon Kinesis stream and a Lambda function.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_sizeInteger

The largest number of records that AWS Lambda will POST in the invocation request to your function.

Returns:

  • (Integer)

    The largest number of records that AWS Lambda will POST in the invocation request to your function.

#event_sourceString

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

#function_nameString

The Lambda function to invoke when AWS Lambda detects an event on the stream.

Returns:

  • (String)

    The Lambda function to invoke when AWS Lambda detects an event on the stream.

#is_activeBoolean

Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.

Returns:

  • (Boolean)

    Indicates whether the event source mapping is currently honored.

#last_modifiedTime

The UTC time string indicating the last time the event mapping was updated.

Returns:

  • (Time)

    The UTC time string indicating the last time the event mapping was updated.

#parametersHash<String,String>

The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.

Returns:

  • (Hash<String,String>)

    The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.

#roleString

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Returns:

  • (String)

    The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

#statusString

The description of the health of the event source mapping. Valid values are: \"PENDING\", \"OK\", and \"PROBLEM:message\". Initially this staus is \"PENDING\". When AWS Lambda begins processing events, it changes the status to \"OK\".

Returns:

  • (String)

    The description of the health of the event source mapping.

#uuidString

The AWS Lambda assigned opaque identifier for the mapping.

Returns:

  • (String)

    The AWS Lambda assigned opaque identifier for the mapping.