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

Class: Aws::Lambda::Types::CreateEventSourceMappingRequest

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

Overview

Note:

When passing CreateEventSourceMappingRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  event_source_arn: "Arn", # required
  function_name: "FunctionName", # required
  enabled: false,
  batch_size: 1,
  maximum_batching_window_in_seconds: 1,
  parallelization_factor: 1,
  starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST, AT_TIMESTAMP
  starting_position_timestamp: Time.now,
  destination_config: {
    on_success: {
      destination: "DestinationArn",
    },
    on_failure: {
      destination: "DestinationArn",
    },
  },
  maximum_record_age_in_seconds: 1,
  bisect_batch_on_function_error: false,
  maximum_retry_attempts: 1,
  topics: ["Topic"],
  queues: ["Queue"],
  source_access_configurations: [
    {
      type: "BASIC_AUTH", # accepts BASIC_AUTH
      uri: "Arn",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#batch_size ⇒ Integer

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

  • Amazon Kinesis - Default 100. Max 10,000.

  • Amazon DynamoDB Streams - Default 100. Max 1,000.

  • Amazon Simple Queue Service - Default 10. Max 10.

  • Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.

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.

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:

#enabled ⇒ Boolean

If true, the event source mapping is active. Set to false to pause polling and invocation.

Returns:

  • (Boolean) —

    If true, the event source mapping is active.

#event_source_arn ⇒ String

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

  • Amazon Kinesis - The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams - The ARN of the stream.

  • Amazon Simple Queue Service - The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka - The ARN of the cluster.

Returns:

  • (String) —

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

#function_name ⇒ String

The name of the Lambda function.

Name formats .title

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it\'s limited to 64 characters in length.

Returns:

  • (String) —

    The name of the Lambda function.

#maximum_batching_window_in_seconds ⇒ Integer

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

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

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 will be 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.

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.

#topics ⇒ Array<String>

(MSK) The name of the Kafka topic.

Returns:

  • (Array<String>) —

    (MSK) The name of the Kafka topic.