Try SpotterCreate a mapping between an event source and an AWS Lambda function
| "added in version" 0.1.0 of amazon.cloud"
Authors: Ansible Cloud Team (@ansible-collections)
Install with ansible-galaxy collection install amazon.cloud:==0.1.0
collections:
- name: amazon.cloud
version: 0.1.0Create a mapping between an event source and an AWS Lambda function.
id:
description:
- Event Source Mapping Identifier UUID.
type: str
wait:
default: false
description:
- Wait for operation to complete before returning.
type: bool
state:
choices:
- present
- absent
- list
- describe
- get
default: present
description:
- Goal state for resource.
- I(state=present) creates the resource if it doesn't exist, or updates to the provided
state if the resource already exists.
- I(state=absent) ensures an existing instance is deleted.
- I(state=list) get all the existing resources.
- I(state=describe) or I(state=get) retrieves information on an existing resource.
type: str
queues:
description:
- (ActiveMQ) A list of ActiveMQ queues.
elements: str
type: list
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
topics:
description:
- (Kafka) A list of Kafka topics.
elements: str
type: list
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
enabled:
description:
- Disables the event source mapping to pause polling and invocation.
type: bool
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).
type: dict
batch_size:
description:
- The maximum number of items to retrieve in a single batch.
type: int
wait_timeout:
default: 320
description:
- How many seconds to wait for an operation to complete before timing out.
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- '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:
description:
- The name of the Lambda function.
required: true
type: str
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_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
filter_criteria:
description:
- The filter criteria to control event filtering.The filter criteria to control event
filtering.
suboptions:
filters:
description:
- The filter object that defines parameters for ESM filtering.
elements: dict
suboptions:
pattern:
description:
- The filter pattern that defines which events should be passed for invocations.
type: str
type: list
type: dict
event_source_arn:
description:
- The Amazon Resource Name (ARN) of the event source.
type: str
starting_position:
description:
- The position in a stream from which to start reading.
- Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
type: str
destination_config:
description:
- (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.(Streams)
An Amazon SQS queue or Amazon SNS topic destination for discarded records.
suboptions:
on_failure:
description:
- The destination configuration for failed invocations.A destination for events
that failed processing.
suboptions:
destination:
description:
- The Amazon Resource Name (ARN) of the destination resource.
type: str
type: dict
type: dict
maximum_retry_attempts:
description:
- (Streams) The maximum number of times to retry when the function returns an error.
type: int
parallelization_factor:
description:
- (Streams) The number of batches to process from each shard concurrently.
type: int
function_response_types:
choices:
- ReportBatchItemFailures
description:
- (Streams) A list of response types supported by the function.
elements: str
type: list
self_managed_event_source:
description:
- Self-managed event source endpoints.The configuration used by AWS Lambda to access
a self-managed event source.
suboptions:
endpoints:
description:
- The endpoints for a self-managed event source.The endpoints used by AWS Lambda
to access a self-managed event source.
suboptions:
kafka_bootstrap_servers:
description:
- The URL of a Kafka server.
elements: str
type: list
type: dict
type: dict
tumbling_window_in_seconds:
description:
- (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.
type: int
starting_position_timestamp:
description:
- With I(starting_position) set to C(AT_TIMESTAMP), the time from which to start reading,
in Unix time seconds.
type: int
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
source_access_configurations:
description:
- The configuration used by AWS Lambda to access event source
elements: dict
suboptions:
type:
choices:
- BASIC_AUTH
- CLIENT_CERTIFICATE_TLS_AUTH
- SASL_SCRAM_256_AUTH
- SASL_SCRAM_512_AUTH
- SERVER_ROOT_CA_CERTIFICATE
- VIRTUAL_HOST
- VPC_SECURITY_GROUP
- VPC_SUBNET
description:
- The type of source access configuration.
type: str
uri:
description:
- The URI for the source access configuration resource.
type: str
type: list
maximum_record_age_in_seconds:
description:
- (Streams) The maximum age of a record that Lambda sends to a function for processing.
type: int
bisect_batch_on_function_error:
description:
- (Streams) If the function returns an error, split the batch in two and retry.
type: bool
maximum_batching_window_in_seconds:
description:
- (Streams) The maximum amount of time to gather records before invoking the function,
in seconds.
type: int
result:
contains:
identifier:
description: The unique identifier of the resource.
type: str
properties:
description: The resource properties.
type: dict
description: Dictionary containing resource information.
returned: always
type: complex