ansible / ansible.builtin / v2.9.0 / module / s3_bucket_notification Creates, updates or deletes S3 Bucket notification for lambda | "added in version" 2.9 of ansible.builtin" Authors: XLAB d.o.o. (@xlab-si), Aljaz Kosir (@aljazkosir), Miha Plesko (@miha-plesko) preview | supported by communityansible.builtin.s3_bucket_notification (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
This module allows the management of AWS Lambda function bucket event mappings via the Ansible framework. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases and M(lambda_policy) to modify lambda permissions.
--- # Example that creates a lambda event notification for a bucket - hosts: localhost gather_facts: no tasks: - name: Process jpg image s3_bucket_notification: state: present event_name: on_file_add_or_remove bucket_name: test-bucket function_name: arn:aws:lambda:us-east-2:526810320200:function:test-lambda events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"] prefix: images/ suffix: .jpg
state: choices: - present - absent default: present description: - Describes the desired state. required: true type: str events: choices: - s3:ObjectCreated:* - s3:ObjectCreated:Put - s3:ObjectCreated:Post - s3:ObjectCreated:Copy - s3:ObjectCreated:CompleteMultipartUpload - s3:ObjectRemoved:* - s3:ObjectRemoved:Delete - s3:ObjectRemoved:DeleteMarkerCreated - s3:ObjectRestore:Post - s3:ObjectRestore:Completed - s3:ReducedRedundancyLostObject description: - Events that you want to be triggering notifications. You can select multiple events to send to the same destination, you can set up different events to send to different destinations, and you can set up a prefix or suffix for an event. However, for each bucket, individual events cannot have multiple configurations with overlapping prefixes or suffixes that could match the same object key. required: true type: list prefix: description: - Optional prefix to limit the notifications to objects with keys that start with matching characters. required: false type: str 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 suffix: description: - Optional suffix to limit the notifications to objects with keys that end with matching characters. required: false 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 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 event_name: description: - unique name for event notification on bucket required: true type: str bucket_name: description: - S3 bucket name required: true type: str lambda_alias: description: - Name of the Lambda function alias. Mutually exclusive with C(lambda_version). required: false type: str 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 lambda_version: description: - Version of the Lambda function. Mutually exclusive with C(lambda_alias). required: false type: int security_token: aliases: - aws_session_token - session_token - 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. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. 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 lambda_function_arn: aliases: - function_arn description: - The ARN of the lambda function. type: str 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
notification_configuration: description: list of currently applied notifications returned: success type: list