Try SpotterCreates, updates or deletes AWS Lambda policy statements.
| "added in version" 2.4 of ansible.builtin"
Authors: Pierre Jodouin (@pjodouin), Michael De La Rue (@mikedlr)
preview | supported by community
pipInstall with pip install ansible==2.9.17
This module allows the management of AWS Lambda policy statements. It is idempotent and supports "Check" mode. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases, M(lambda_event) to manage event source mappings such as Kinesis streams, M(execute_lambda) to execute a lambda function and M(lambda_info) to gather information relating to one or more lambda functions.
---
- hosts: localhost
gather_facts: no
vars:
state: present
tasks:
- name: Lambda S3 event notification
lambda_policy:
state: "{{ state | default('present') }}"
function_name: functionName
alias: Dev
statement_id: lambda-s3-myBucket-create-data-log
action: lambda:InvokeFunction
principal: s3.amazonaws.com
source_arn: arn:aws:s3:eu-central-1:123456789012:bucketName
source_account: 123456789012
register: lambda_policy_action
- name: show results
debug:
var: lambda_policy_action
alias:
description:
- Name of the function alias. Mutually exclusive with C(version).
state:
choices:
- present
- absent
default: present
description:
- Describes the desired state.
action:
description:
- 'The AWS Lambda action you want to allow in this statement. Each Lambda action is
a string starting with lambda: followed by the API name (see Operations ). For example,
lambda:CreateFunction . You can use wildcard (lambda:* ) to grant permission for
all AWS Lambda actions.'
required: true
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
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
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
version:
description:
- Version of the Lambda function. Mutually exclusive with C(alias).
principal:
description:
- The principal who is getting this permission. It can be Amazon S3 service Principal
(s3.amazonaws.com ) if you want Amazon S3 to invoke the function, an AWS account
ID if you are granting cross-account permission, or any valid AWS service principal
such as sns.amazonaws.com . For example, you might want to allow a custom application
in another AWS account to push events to AWS Lambda by invoking your function.
required: true
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
source_arn:
description:
- This is optional; however, when granting Amazon S3 permission to invoke your function,
you should specify this field with the bucket Amazon Resource Name (ARN) as its
value. This ensures that only events generated from the specified bucket can invoke
the function.
statement_id:
aliases:
- sid
description:
- A unique statement identifier.
required: true
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
function_name:
aliases:
- lambda_function_arn
- function_arn
description:
- Name of the Lambda function whose resource policy you are updating by adding a new
permission.
- You can specify a function name (for example, Thumbnail ) or you can specify Amazon
Resource Name (ARN) of the
- function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail ).
AWS Lambda also allows you to
- specify partial ARN (for example, account-id:Thumbnail ). Note that the length constraint
applies only to the
- ARN. If you specify only the function name, it is limited to 64 character in length.
required: true
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
source_account:
description:
- The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn
identifies a bucket, then this is the bucket owner's account ID. You can use this
additional condition to ensure the bucket you specify is owned by a specific account
(it is possible the bucket owner deleted the bucket and some other AWS account created
the bucket). You can also use this condition to specify all sources (that is, you
don't specify the SourceArn ) owned by a specific account.
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
event_source_token:
description:
- Token string representing source ARN or account. Mutually exclusive with C(source_arn)
or C(source_account).
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
lambda_policy_action: description: describes what action was taken returned: success type: str