You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#batch_sizeInteger

The largest number of records that AWS Lambda will POST in the invocation request to your function.

Returns:

  • (Integer)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#event_sourceString

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

Returns:

  • (String)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#function_nameString

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

Returns:

  • (String)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#is_activeBoolean

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

Returns:

  • (Boolean)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#last_modifiedTime

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

Returns:

  • (Time)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#parametersHash<String,String>

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

Returns:

  • (Hash<String,String>)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#roleString

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

Returns:

  • (String)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#statusString

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)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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

#uuidString

The AWS Lambda assigned opaque identifier for the mapping.

Returns:

  • (String)


139
140
141
142
143
144
145
146
147
148
149
150
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 139

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