community.aws.s3_bucket_notification – Creates, updates or deletes S3 Bucket notification for lambda  Note This plugin is part of the community.aws collection (version 1.3.0). To install it use: ansible-galaxy collection install community.aws. To use it in a playbook, specify: community.aws.s3_bucket_notification.   New in version 1.0.0: of community.aws   Synopsis Requirements Parameters Notes Examples Return Values  Synopsis  This module allows the management of AWS Lambda function bucket event mappings via the Ansible framework. Use module community.aws.lambda to manage the lambda function itself, community.aws.lambda_alias to manage function aliases and community.aws.lambda_policy to modify lambda permissions.  Requirements The below requirements are needed on the host that executes this module.  boto boto3 python >= 2.6  Parameters   Parameter Choices/Defaults Comments    aws_access_key  string      AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 
aliases: ec2_access_key, access_key     aws_ca_bundle  path      The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.     aws_config  dictionary      A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.     aws_secret_key  string      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 
aliases: ec2_secret_key, secret_key     bucket_name  string / required      S3 bucket name.     debug_botocore_endpoint_logs  boolean    
Choices: 
no ← yes    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.     ec2_url  string      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. 
aliases: aws_endpoint_url, endpoint_url     event_name  string / required      Unique name for event notification on bucket.     events  list / elements=string    
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    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 when state=present.     lambda_alias  string      Name of the Lambda function alias. Mutually exclusive with lambda_version.     lambda_function_arn  string      The ARN of the lambda function. 
aliases: function_arn     lambda_version  integer      Version of the Lambda function. Mutually exclusive with lambda_alias.     prefix  string      Optional prefix to limit the notifications to objects with keys that start with matching characters.     profile  string      Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. 
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. 
aliases: aws_profile     region  string      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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
 
aliases: aws_region, ec2_region     security_token  string      AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 
aliases: aws_security_token, access_token     state  string    
Choices: 
present ← absent    Describes the desired state.     suffix  string      Optional suffix to limit the notifications to objects with keys that end with matching characters.     validate_certs  boolean    
Choices: no 
yes ←    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.     Notes  Note  This module heavily depends on community.aws.lambda_policy as you need to allow lambda:InvokeFunction permission for your lambda function. If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
 Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
 
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file   Examples ---
# Example that creates a lambda event notification for a bucket
- name: Process jpg image
  community.aws.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
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    notification_configuration  list / elements=string   success  list of currently applied notifications      Authors  XLAB d.o.o. (@xlab-si) Aljaz Kosir (@aljazkosir) Miha Plesko (@miha-plesko) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.10/collections/community/aws/s3_bucket_notification_module.html', 'source': 'DevDocs.IO'}