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::UpdateEventSourceMappingRequest

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

Overview

Note:

When making an API call, you may pass UpdateEventSourceMappingRequest data as a hash:

{
  uuid: "String", # required
  function_name: "FunctionName",
  enabled: false,
  batch_size: 1,
  maximum_batching_window_in_seconds: 1,
  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,
  parallelization_factor: 1,
  source_access_configurations: [
    {
      type: "BASIC_AUTH", # accepts BASIC_AUTH, VPC_SUBNET, VPC_SECURITY_GROUP, SASL_SCRAM_512_AUTH, SASL_SCRAM_256_AUTH
      uri: "URI",
    },
  ],
  tumbling_window_in_seconds: 1,
  function_response_types: ["ReportBatchItemFailures"], # accepts ReportBatchItemFailures
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_sizeInteger

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. For standard queues the max is 10,000. For FIFO queues the max is 10.

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

  • Self-Managed Apache Kafka - Default 100. Max 10,000.

Returns:

  • (Integer)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  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)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configTypes::DestinationConfig

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



5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

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

Returns:

  • (Boolean)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#function_nameString

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)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#function_response_typesArray<String>

(Streams) A list of current response type enums applied to the event source mapping.

Returns:

  • (Array<String>)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_batching_window_in_secondsInteger

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

Returns:

  • (Integer)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_record_age_in_secondsInteger

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

Returns:

  • (Integer)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_retry_attemptsInteger

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


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factorInteger

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

Returns:

  • (Integer)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#source_access_configurationsArray<Types::SourceAccessConfiguration>

An array of the authentication protocol, or the VPC components to secure your event source.



5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#tumbling_window_in_secondsInteger

(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.

Returns:

  • (Integer)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end

#uuidString

The identifier of the event source mapping.

Returns:

  • (String)


5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 5216

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :parallelization_factor,
  :source_access_configurations,
  :tumbling_window_in_seconds,
  :function_response_types)
  SENSITIVE = []
  include Aws::Structure
end