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.4.0
collections:
- name: amazon.cloud
version: 0.4.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
force:
default: false
description:
- Cancel IN_PROGRESS and PENDING resource requestes.
- Because you can only perform a single operation on a given resource at a time, there
might be cases where you need to cancel the current resource operation to make the
resource available so that another operation may be performed on it.
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.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
topics:
description:
- (Kafka) A list of Kafka topics.
elements: str
type: list
enabled:
description:
- Disables the event source mapping to pause polling and invocation.
type: bool
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation 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
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
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.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
function_name:
description:
- The name of the Lambda function.
type: str
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
scaling_config:
description:
- The scaling configuration for the event source.The scaling configuration for the
event source.
suboptions:
maximum_concurrency:
description:
- The maximum number of concurrent functions that the event source can invoke.The
maximum number of concurrent functions that an event source can invoke.
type: int
type: dict
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
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 StartingPosition set to C(AT_TIMESTAMP), the time from which to start reading,
in Unix time seconds.
type: int
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(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
self_managed_kafka_event_source_config:
description:
- Specific configuration settings for a Self-Managed Apache Kafka event source.Specific
configuration settings for a Self-Managed Apache Kafka event source.
suboptions:
consumer_group_id:
description:
- The identifier for the Kafka Consumer Group to join.
type: str
type: dict
amazon_managed_kafka_event_source_config:
description:
- Specific configuration settings for an MSK event source.Specific configuration settings
for an MSK event source.
suboptions:
consumer_group_id:
description:
- The identifier for the Kafka Consumer Group to join.The identifier for the Kafka
Consumer Group to join.
type: str
type: dict
result:
contains:
identifier:
description: The unique identifier of the resource.
type: str
properties:
description: The resource properties.
type: dict
description:
- When I(state=list), it is a list containing dictionaries of resource information.
- Otherwise, it is a dictionary of resource information.
- When I(state=absent), it is an empty dictionary.
returned: always
type: complex