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

Inherits:

Struct

Object
Struct
Aws::Lambda::Types::CreateEventSourceMappingRequest

show all

Defined in:: gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

Note:

When making an API call, you may pass CreateEventSourceMappingRequest data as a 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"],
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#batch_size ⇒ 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.
#destination_config ⇒ Types::DestinationConfig
(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
#enabled ⇒ Boolean
If true, the event source mapping is active.
#event_source_arn ⇒ String
The Amazon Resource Name (ARN) of the event source.
#function_name ⇒ 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.
#maximum_record_age_in_seconds ⇒ Integer
(Streams) Discard records older than the specified age.
#maximum_retry_attempts ⇒ Integer
(Streams) Discard records after the specified number of retries.
#parallelization_factor ⇒ Integer
(Streams) The number of batches to process from each shard concurrently.
#starting_position ⇒ 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.
#topics ⇒ Array<String>
(MSK) The name of the Kafka topic.

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)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#bisect_batch_on_function_error ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#destination_config ⇒ `Types::DestinationConfig`

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

Returns:

(Types::DestinationConfig)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#function_name ⇒ `String`

The name of the Lambda function.

Name formats

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)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_batching_window_in_seconds ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_record_age_in_seconds ⇒ `Integer`

(Streams) Discard records older than the specified age. The default value is infinite (-1).

Returns:

(Integer)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factor ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position_timestamp ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

#topics ⇒ `Array<String>`

(MSK) The name of the Kafka topic.

Returns:

(Array<String>)

# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 558

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :topics)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#batch_size ⇒ Integer

#bisect_batch_on_function_error ⇒ Boolean

#destination_config ⇒ Types::DestinationConfig

#enabled ⇒ Boolean

#event_source_arn ⇒ String

#function_name ⇒ String

#maximum_batching_window_in_seconds ⇒ Integer

#maximum_record_age_in_seconds ⇒ Integer

#maximum_retry_attempts ⇒ Integer

#parallelization_factor ⇒ Integer

#starting_position ⇒ String

#starting_position_timestamp ⇒ Time

#topics ⇒ Array<String>

#batch_size ⇒ `Integer`

#bisect_batch_on_function_error ⇒ `Boolean`

#destination_config ⇒ `Types::DestinationConfig`

#enabled ⇒ `Boolean`

#event_source_arn ⇒ `String`

#function_name ⇒ `String`

#maximum_batching_window_in_seconds ⇒ `Integer`

#maximum_record_age_in_seconds ⇒ `Integer`

#maximum_retry_attempts ⇒ `Integer`

#parallelization_factor ⇒ `Integer`

#starting_position ⇒ `String`

#starting_position_timestamp ⇒ `Time`

#topics ⇒ `Array<String>`