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.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_sizeInteger

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

Returns:

  • (Integer)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#bisect_batch_on_function_errorBoolean

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

Returns:

  • (Boolean)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configTypes::DestinationConfig

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



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_arnString

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

Returns:

  • (String)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#function_arnString

The ARN of the Lambda function.

Returns:

  • (String)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#last_modifiedTime

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

Returns:

  • (Time)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#last_processing_resultString

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

Returns:

  • (String)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_batching_window_in_secondsInteger

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

Returns:

  • (Integer)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_record_age_in_secondsInteger

(Streams) The maximum age of a record that Lambda sends to a function for processing.

Returns:

  • (Integer)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_retry_attemptsInteger

(Streams) The maximum number of times to retry when the function returns an error.

Returns:

  • (Integer)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factorInteger

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

Returns:

  • (Integer)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

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

Returns:

  • (String)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#state_transition_reasonString

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

Returns:

  • (String)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#topicsArray<String>

(MSK) The name of the Kafka topic.

Returns:

  • (Array<String>)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#uuidString

The identifier of the event source mapping.

Returns:

  • (String)


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1343

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts)
  SENSITIVE = []
  include Aws::Structure
end