Class: Aws::LambdaPreview::Types::EventSourceConfiguration

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

Overview

Describes mapping between an Amazon Kinesis stream and a Lambda function.

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 POST in the invocation request to your function.

Returns:

  • (Integer) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#event_source ⇒ String

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

Returns:

  • (String) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#function_name ⇒ String

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

Returns:

  • (String) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#is_active ⇒ Boolean

Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

The UTC time string indicating the last time the event mapping was updated.

Returns:

  • (Time) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,String>

The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.

Returns:

  • (Hash<String,String>) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  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) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The description of the health of the event source mapping. Valid values are: "PENDING", "OK", and "PROBLEM:message". Initially this staus is "PENDING". When AWS Lambda begins processing events, it changes the status to "OK".

Returns:

  • (String) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#uuid ⇒ String

The AWS Lambda assigned opaque identifier for the mapping.

Returns:

  • (String) 


123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 123

class EventSourceConfiguration < Struct.new(
  :uuid,
  :batch_size,
  :event_source,
  :function_name,
  :parameters,
  :role,
  :last_modified,
  :is_active,
  :status)
  SENSITIVE = []
  include Aws::Structure
end