Parameter |
Choices/Defaults |
Comments |
aws_access_key
|
|
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.
aliases: ec2_access_key, access_key
|
aws_secret_key
|
|
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.
aliases: ec2_secret_key, secret_key
|
description
|
|
A description of the rule
|
ec2_url
|
|
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.
|
event_pattern
|
|
A string pattern (in valid JSON format) that is used to match against incoming events to determine if the rule should be triggered
|
name
required |
|
The name of the rule you are creating, updating or deleting. No spaces or special characters allowed (i.e. must match [\.\-_A-Za-z0-9]+ )
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
role_arn
|
|
The Amazon Resource Name (ARN) of the IAM role associated with the rule
|
schedule_expression
|
|
A cron or rate expression that defines the schedule the rule will trigger on. For example, cron(0 20 * * ? * ), rate(5 minutes )
|
security_token
(added in 1.6) |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
|
state
|
Choices:
present ←
- disabled
- absent
|
Whether the rule is present (and enabled), disabled, or absent
|
targets
|
|
A dictionary array of targets to add to or update for the rule, in the form { 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]}} . id [required] is the unique target assignment ID. arn (required) is the Amazon Resource Name associated with the target. role_arn (optional) is The Amazon Resource Name of the IAM role to be used for this target when the rule is triggered. input (optional) is a JSON object that will override the event data when passed to the target. input_path (optional) is a JSONPath string (e.g. $.detail ) that specifies the part of the event data to be passed to the target. If neither input nor input_path is specified, then the entire event is passed to the target in JSON form. task_definition_arn [optional] is ecs task definition arn. task_count [optional] is ecs task count.
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|