Class: Aws::LambdaPreview::Types::AddEventSourceRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lambdapreview/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_size ⇒ Integer

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

Returns:

  • (Integer) 


50
51
52
53
54
55
56
57
58
 
# File 'lib/aws-sdk-lambdapreview/types.rb', line 50

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#event_source ⇒ String

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
 
# File 'lib/aws-sdk-lambdapreview/types.rb', line 50

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#function_name ⇒ String

The Lambda function to invoke when AWS Lambda detects an event on the stream.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
 
# File 'lib/aws-sdk-lambdapreview/types.rb', line 50

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,String>

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the ‘InitialPositionInStream` key. The valid values are: “TRIM_HORIZON” and “LATEST”. The default value is “TRIM_HORIZON”. For more information, go to

ShardIteratorType][1

in the Amazon Kinesis Service API Reference.

[1]: docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType

Returns:

  • (Hash<String,String>) 


50
51
52
53
54
55
56
57
58
 
# File 'lib/aws-sdk-lambdapreview/types.rb', line 50

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Returns:

  • (String) 


50
51
52
53
54
55
56
57
58
 
# File 'lib/aws-sdk-lambdapreview/types.rb', line 50

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end