Class: Ansible::Ruby::Modules::Lambda_event

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb

Overview

This module allows the management of AWS Lambda function event source mappings such as DynamoDB and Kinesis stream events via the Ansible framework. These event source mappings are relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. It is idempotent and supports “Check” mode. Use module M(lambda) to manage the lambda function itself and M(lambda_alias) to manage function aliases.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#alias ⇒ Object

Returns Name of the function alias. Mutually exclusive with C(version).

Returns:

  • (Object) —

    Name of the function alias. Mutually exclusive with C(version).



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb', line 20

attribute :alias

#event_source ⇒ :stream, ...

Returns Source of the event that triggers the lambda function.,For DynamoDB and Kinesis events, select ‘stream’,For SQS queues, select ‘sqs’.

Returns:

  • (:stream, :sqs, nil) —

    Source of the event that triggers the lambda function.,For DynamoDB and Kinesis events, select ‘stream’,For SQS queues, select ‘sqs’



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb', line 27

attribute :event_source

#lambda_function_arn ⇒ Object

Returns The name or ARN of the lambda function.

Returns:

  • (Object) —

    The name or ARN of the lambda function.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb', line 12

attribute :lambda_function_arn

#source_params ⇒ Object

Returns Sub-parameters required for event source.,I(== stream event source ==),C(source_arn) The Amazon Resource Name (ARN) of the Kinesis or DynamoDB stream that is the event source.,C(enabled) Indicates whether AWS Lambda should begin polling the event source. Default is True.,C(batch_size) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Default is 100.,C(starting_position) The position in the stream where AWS Lambda should start reading. Choices are TRIM_HORIZON or LATEST.,I(== sqs event source ==),C(source_arn) The Amazon Resource Name (ARN) of the SQS queue to read events from.,C(enabled) Indicates whether AWS Lambda should begin reading from the event source. Default is True.,C(batch_size) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Default is 100.

Returns:

  • (Object) —

    Sub-parameters required for event source.,I(== stream event source ==),C(source_arn) The Amazon Resource Name (ARN) of the Kinesis or DynamoDB stream that is the event source.,C(enabled) Indicates whether AWS Lambda should begin polling the event source. Default is True.,C(batch_size) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Default is 100.,C(starting_position) The position in the stream where AWS Lambda should start reading. Choices are TRIM_HORIZON or LATEST.,I(== sqs event source ==),C(source_arn) The Amazon Resource Name (ARN) of the SQS queue to read events from.,C(enabled) Indicates whether AWS Lambda should begin reading from the event source. Default is True.,C(batch_size) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Default is 100.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb', line 31

attribute :source_params

#state ⇒ :present, :absent

Returns Describes the desired state.

Returns:

  • (:present, :absent) —

    Describes the desired state.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb', line 16

attribute :state

#version ⇒ Object?

Returns Version of the Lambda function. Mutually exclusive with C(alias).

Returns:

  • (Object, nil) —

    Version of the Lambda function. Mutually exclusive with C(alias).



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lambda_event.rb', line 24

attribute :version