Class: Ansible::Ruby::Modules::Execute_lambda

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

Overview

This module executes AWS Lambda functions, allowing synchronous and asynchronous invocation.

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

#dry_run ⇒ :yes, ...

Returns Do not actually invoke the function. A C(DryRun) call will check that the caller has permissions to call the function, especially for checking cross-account permissions.

Returns:

  • (:yes, :no, nil) —

    Do not actually invoke the function. A C(DryRun) call will check that the caller has permissions to call the function, especially for checking cross-account permissions.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/execute_lambda.rb', line 28

attribute :dry_run

#function_arn ⇒ String?

Returns The name of the function to be invoked.

Returns:

  • (String, nil) —

    The name of the function to be invoked



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

attribute :function_arn

#name ⇒ String?

Returns The name of the function to be invoked. This can only be used for invocations within the calling account. To invoke a function in another account, use I(function_arn) to specify the full ARN.

Returns:

  • (String, nil) —

    The name of the function to be invoked. This can only be used for invocations within the calling account. To invoke a function in another account, use I(function_arn) to specify the full ARN.



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

attribute :name

#payload ⇒ Object?

Returns A dictionary in any form to be provided as input to the Lambda function.

Returns:

  • (Object, nil) —

    A dictionary in any form to be provided as input to the Lambda function.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/execute_lambda.rb', line 36

attribute :payload

#tail_log ⇒ :yes, ...

Returns If C(tail_log=yes), the result of the task will include the last 4 KB of the CloudWatch log for the function execution. Log tailing only works if you use synchronous invocation C(wait=yes). This is usually used for development or testing Lambdas.

Returns:

  • (:yes, :no, nil) —

    If C(tail_log=yes), the result of the task will include the last 4 KB of the CloudWatch log for the function execution. Log tailing only works if you use synchronous invocation C(wait=yes). This is usually used for development or testing Lambdas.



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

attribute :tail_log

#version_qualifier ⇒ String?

Returns Which version/alias of the function to run. This defaults to the C(LATEST) revision, but can be set to any existing version or alias. See https;//docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html for details.

Returns:

  • (String, nil) —

    Which version/alias of the function to run. This defaults to the C(LATEST) revision, but can be set to any existing version or alias. See https;//docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html for details.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/execute_lambda.rb', line 32

attribute :version_qualifier

#wait ⇒ :yes, ...

Returns Whether to wait for the function results or not. If I(wait) is C(no), the task will not return any results. To wait for the Lambda function to complete, set C(wait=yes) and the result will be available in the I(output) key.

Returns:

  • (:yes, :no, nil) —

    Whether to wait for the function results or not. If I(wait) is C(no), the task will not return any results. To wait for the Lambda function to complete, set C(wait=yes) and the result will be available in the I(output) key.



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

attribute :wait