Try SpotterCreate and manage Lambda functions
| "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.0Creates and manage Lambda functions.
code:
description:
- The code for the function.
suboptions:
image_uri:
description:
- I(image_uri).
type: str
s3_bucket:
description:
- An Amazon S3 bucket in the same AWS Region as your function.
- The bucket can be in a different AWS account.
type: str
s3_key:
description:
- The Amazon S3 key of the deployment package.
type: str
s3_object_version:
description:
- For versioned objects, the version of the deployment package object to use.
type: str
zip_file:
description:
- The source code of your Lambda function.
- If you include your function source inline with this parameter, AWS CloudFormation
places it in a file named index and zips it to create a deployment package..
type: str
type: dict
role:
description:
- The Amazon Resource Name (ARN) of the functions execution role.
type: str
tags:
aliases:
- resource_tags
description:
- A dict of tags to apply to the resource.
- To remove all tags set I(tags={}) and I(purge_tags=true).
type: dict
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
layers:
description:
- A list of function layers to add to the functions execution environment.
- Specify each layer by its ARN, including the version.
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
handler:
description:
- The name of the method within your code that Lambda calls to execute your function.
- The format includes the file name.
- It can also include namespaces and other qualifiers, depending on the runtime.
type: str
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
runtime:
description:
- The identifier of the functions runtime.
type: str
timeout:
description:
- The amount of time that Lambda allows a function to run before stopping it.
- The default is 3 seconds.
- The maximum allowed value is 900 seconds.
type: int
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
purge_tags:
default: true
description:
- Remove tags not listed in I(tags).
type: bool
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
snap_start:
description:
- The I(snap_start) setting of your functionThe functions I(snap_start) setting.
- When set to PublishedVersions, Lambda creates a snapshot of the execution environment
when you publish a function version.
suboptions: {}
type: dict
vpc_config:
description:
- For network connectivity to AWS resources in a VPC, specify a list of security groups
and subnets in the VPC.The VPC security groups and subnets that are attached to
a Lambda function.
- When you connect a function to a VPC, Lambda creates an elastic network interface
for each combination of security group and subnet in the functions VPC configuration.
- The function can only access resources and the internet through that VPC.
suboptions:
security_group_ids:
description:
- A list of VPC security groups IDs.
elements: str
type: list
subnet_ids:
description:
- A list of VPC subnet IDs.
elements: str
type: list
type: dict
description:
description:
- A description of the function.
type: str
environment:
description:
- Environment variables that are accessible from function code during execution.A
functions environment variable settings.
suboptions:
variables:
description:
- Environment variable key-value pairs.
type: dict
type: dict
kms_key_arn:
description:
- The ARN of the AWS Key Management Service (AWS KMS) key thats used to encrypt your
functions environment variables.
- If its not provided, AWS Lambda uses a default service key.
type: str
memory_size:
description:
- The amount of memory that your function has access to.
- Increasing the functions memory also increases its CPU allocation.
- The default value is 128 MB. The value must be a multiple of 64 MB.
type: int
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
image_config:
description:
- I(image_config).
suboptions:
command:
description:
- Command.
elements: str
type: list
entry_point:
description:
- I(entry_point).
elements: str
type: list
working_directory:
description:
- I(working_directory).
type: str
type: dict
package_type:
choices:
- Image
- Zip
description:
- PackageType.
type: str
wait_timeout:
default: 320
description:
- How many seconds to wait for an operation to complete before timing out.
type: int
architectures:
choices:
- arm64
- x86_64
description:
- Not Provived.
elements: str
type: list
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, up to 64 characters in length.
- If you dont specify a name, AWS CloudFormation generates one.
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
tracing_config:
description:
- Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.The
functions AWS X-Ray tracing configuration.
- To sample and record incoming requests, set Mode to Active.
suboptions:
mode:
choices:
- Active
- PassThrough
description:
- The tracing mode.
type: str
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
ephemeral_storage:
description:
- A functions ephemeral storage settings.A functions ephemeral storage settings.
suboptions:
size:
description:
- The amount of ephemeral storage that your function has access to.
type: int
type: dict
dead_letter_config:
description:
- A dead letter queue configuration that specifies the queue or topic where Lambda
sends asynchronous events when they fail processing.The dead-letter queue for failed
asynchronous invocations.
suboptions:
target_arn:
description:
- The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
type: str
type: dict
file_system_configs:
description:
- Connection settings for an Amazon EFS file system.
- To connect a function to a file system, a mount target must be available in every
Availability Zone that your function connects to.
- If your template contains an AWS::EFS::MountTarget resource, you must also specify
a DependsOn attribute to ensure that the mount target is created or updated before
the function.
elements: dict
suboptions:
local_mount_path:
description:
- The path where the function can access the file system, starting with /mnt/.
type: str
type: list
code_signing_config_arn:
description:
- A unique Arn for CodeSigningConfig resource.
type: str
runtime_management_config:
description:
- I(runtime_management_config).
suboptions:
runtime_version_arn:
description:
- Unique identifier for a runtime version arn.
type: str
update_runtime_on:
choices:
- Auto
- FunctionUpdate
- Manual
description:
- Trigger for runtime update.
type: str
type: dict
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
reserved_concurrent_executions:
description:
- The number of simultaneous executions to reserve for the function.
type: int
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