Try SpotterExecute an AWS Lambda function
| "added in version" 2.2 of ansible.builtin"
Authors: Ryan Scott Brown (@ryansb) <ryansb@redhat.com>
preview | supported by community
pipInstall with pip install ansible==2.9.17
This module executes AWS Lambda functions, allowing synchronous and asynchronous invocation.
- execute_lambda:
name: test-function
# the payload is automatically serialized and sent to the function
payload:
foo: bar
value: 8
register: response
# Test that you have sufficient permissions to execute a Lambda function in
# another account
- execute_lambda:
function_arn: arn:aws:lambda:us-east-1:123456789012:function/some-function
dry_run: true
- execute_lambda:
name: test-function
payload:
foo: bar
value: 8
wait: true
tail_log: true
register: response
# the response will have a `logs` key that will contain a log (up to 4KB) of the function execution in Lambda
# Pass the Lambda event payload as a json file.
- execute_lambda:
name: test-function
payload: "{{ lookup('file','lambda_event.json') }}"
register: response
- execute_lambda:
name: test-function
version_qualifier: PRODUCTION
name:
description:
- 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.
wait:
default: 'yes'
description:
- 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.
type: bool
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
dry_run:
default: 'no'
description:
- 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.
type: bool
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
payload:
default: {}
description:
- A dictionary in any form to be provided as input to the Lambda function.
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
tail_log:
default: 'no'
description:
- 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.
type: bool
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
function_arn:
description:
- The name of the function to be invoked
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
version_qualifier:
default: LATEST
description:
- 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 U(https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html)
for details.
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
logs:
description: The last 4KB of the function logs. Only provided if I(tail_log) is
true
returned: if I(tail_log) == true
type: str
output:
description: Function output if wait=true and the function returns a value
returned: success
sample: '{ ''output'': ''something'' }'
type: dict
status:
description: C(StatusCode) of API call exit (200 for synchronous invokes, 202 for
async)
returned: always
sample: 200
type: int