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

Class: Aws::Lambda::Types::EventSourceMappingConfiguration

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

Overview

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_size ⇒ Integer

The maximum number of items to retrieve in a single batch.

Returns:

  • (Integer) —

    The maximum number of items to retrieve in a single batch.

#bisect_batch_on_function_error ⇒ Boolean

(Streams) If the function returns an error, split the batch in two and retry. The default value is false.

Returns:

  • (Boolean) —

    (Streams) If the function returns an error, split the batch in two and retry.

#destination_config ⇒ Types::DestinationConfig

(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Returns:

#event_source_arn ⇒ String

The Amazon Resource Name (ARN) of the event source.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the event source.

#function_arn ⇒ String

The ARN of the Lambda function.

Returns:

  • (String) —

    The ARN of the Lambda function.

#last_modified ⇒ Time

The date that the event source mapping was last updated, or its state changed.

Returns:

  • (Time) —

    The date that the event source mapping was last updated, or its state changed.

#last_processing_result ⇒ String

The result of the last AWS Lambda invocation of your Lambda function.

Returns:

  • (String) —

    The result of the last AWS Lambda invocation of your Lambda function.

#maximum_batching_window_in_seconds ⇒ Integer

(Streams) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

Returns:

  • (Integer) —

    (Streams) The maximum amount of time to gather records before invoking the function, in seconds.

#maximum_record_age_in_seconds ⇒ Integer

(Streams) Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

Returns:

  • (Integer) —

    (Streams) Discard records older than the specified age.

#maximum_retry_attempts ⇒ Integer

(Streams) 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.

Returns:

  • (Integer) —

    (Streams) Discard records after the specified number of retries.

#parallelization_factor ⇒ Integer

(Streams) The number of batches to process from each shard concurrently. The default value is 1.

Returns:

  • (Integer) —

    (Streams) The number of batches to process from each shard concurrently.

#queues ⇒ Array<String>

(MQ) The name of the Amazon MQ broker destination queue to consume.

Returns:

  • (Array<String>) —

    (MQ) The name of the Amazon MQ broker destination queue to consume.

#source_access_configurations ⇒ Array<Types::SourceAccessConfiguration>

(MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format: { "username": "your username", "password": "your password" }

To reference the secret, use the following format: [ { "Type": "BASIC_AUTH", "URI": "secretARN" } ]

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

Returns:

#starting_position ⇒ String

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

Possible values:

  • TRIM_HORIZON
  • LATEST
  • AT_TIMESTAMP

Returns:

  • (String) —

    The position in a stream from which to start reading.

#starting_position_timestamp ⇒ Time

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

Returns:

  • (Time) —

    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

#state ⇒ String

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

Returns:

  • (String) —

    The state of the event source mapping.

#state_transition_reason ⇒ String

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

Returns:

  • (String) —

    Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

#topics ⇒ Array<String>

(MSK) The name of the Kafka topic to consume.

Returns:

  • (Array<String>) —

    (MSK) The name of the Kafka topic to consume.

#uuid ⇒ String

The identifier of the event source mapping.

Returns:

  • (String) —

    The identifier of the event source mapping.