Try SpotterManage CloudWatch Event rules and targets
| "added in version" 2.2 of ansible.builtin"
Authors: Jim Dalton (@jsdalton) <jim.dalton@gmail.com>
preview | supported by community
pipInstall with pip install ansible==2.9.17
This module creates and manages CloudWatch event rules and targets.
- cloudwatchevent_rule:
name: MyCronTask
schedule_expression: "cron(0 20 * * ? *)"
description: Run my scheduled task
targets:
- id: MyTargetId
arn: arn:aws:lambda:us-east-1:123456789012:function:MyFunction
- cloudwatchevent_rule:
name: MyDisabledCronTask
schedule_expression: "rate(5 minutes)"
description: Run my disabled scheduled task
state: disabled
targets:
- id: MyOtherTargetId
arn: arn:aws:lambda:us-east-1:123456789012:function:MyFunction
input: '{"foo": "bar"}'
- cloudwatchevent_rule:
name: MyCronTask
state: absent
name:
description:
- The name of the rule you are creating, updating or deleting. No spaces or special
characters allowed (i.e. must match C([\.\-_A-Za-z0-9]+))
required: true
state:
choices:
- present
- disabled
- absent
default: present
description:
- Whether the rule is present (and enabled), disabled, or absent
required: false
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
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
targets:
description:
- 'A dictionary array of targets to add to or update for the rule, in the form C({
id: [string], arn: [string], role_arn: [string], input: [valid JSON string], input_path:
[valid JSONPath string], ecs_parameters: {task_definition_arn: [string], task_count:
[int]}}). I(id) [required] is the unique target assignment ID. I(arn) (required)
is the Amazon Resource Name associated with the target. I(role_arn) (optional) is
The Amazon Resource Name of the IAM role to be used for this target when the rule
is triggered. I(input) (optional) is a JSON object that will override the event
data when passed to the target. I(input_path) (optional) is a JSONPath string (e.g.
C($.detail)) that specifies the part of the event data to be passed to the target.
If neither I(input) nor I(input_path) is specified, then the entire event is passed
to the target in JSON form. I(task_definition_arn) [optional] is ecs task definition
arn. I(task_count) [optional] is ecs task count.'
required: false
role_arn:
description:
- The Amazon Resource Name (ARN) of the IAM role associated with the rule
required: false
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
description:
description:
- A description of the rule
required: false
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
event_pattern:
description:
- A string pattern (in valid JSON format) that is used to match against incoming events
to determine if the rule should be triggered
required: false
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_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.
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
schedule_expression:
description:
- A cron or rate expression that defines the schedule the rule will trigger on. For
example, C(cron(0 20 * * ? *)), C(rate(5 minutes))
required: false
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
rule:
description: CloudWatch Event rule data
returned: success
sample:
arn: arn:aws:events:us-east-1:123456789012:rule/MyCronTask
description: Run my scheduled task
name: MyCronTask
schedule_expression: cron(0 20 * * ? *)
state: ENABLED
type: dict
targets:
description: CloudWatch Event target(s) assigned to the rule
returned: success
sample: '[{ ''arn'': ''arn:aws:lambda:us-east-1:123456789012:function:MyFunction'',
''id'': ''MyTargetId'' }]'
type: list