Resource Type definition for AWS::Events::Rule
description
(String) The description of the rule.event_bus_name
(String) The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.event_pattern
(String) The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.name
(String) The name of the rule.role_arn
(String) The Amazon Resource Name (ARN) of the role that is used for target invocation.schedule_expression
(String) The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.state
(String) The state of the rule.targets
(Attributes Set) Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered. (see below for nested schema)arn
(String) The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.id
(String) Uniquely identifies the resource.targets
Required:
arn
(String)id
(String)Optional:
app_sync_parameters
(Attributes) (see below for nested schema)batch_parameters
(Attributes) (see below for nested schema)dead_letter_config
(Attributes) (see below for nested schema)ecs_parameters
(Attributes) (see below for nested schema)http_parameters
(Attributes) (see below for nested schema)input
(String)input_path
(String)input_transformer
(Attributes) (see below for nested schema)kinesis_parameters
(Attributes) (see below for nested schema)redshift_data_parameters
(Attributes) (see below for nested schema)retry_policy
(Attributes) (see below for nested schema)role_arn
(String)run_command_parameters
(Attributes) (see below for nested schema)sage_maker_pipeline_parameters
(Attributes) (see below for nested schema)sqs_parameters
(Attributes) (see below for nested schema)targets.app_sync_parameters
Required:
graph_ql_operation
(String)targets.batch_parameters
Required:
job_definition
(String)job_name
(String)Optional:
array_properties
(Attributes) (see below for nested schema)retry_strategy
(Attributes) (see below for nested schema)targets.batch_parameters.array_properties
Optional:
size
(Number)targets.batch_parameters.retry_strategy
Optional:
attempts
(Number)targets.dead_letter_config
Optional:
arn
(String)targets.ecs_parameters
Required:
task_definition_arn
(String)Optional:
capacity_provider_strategy
(Attributes List) (see below for nested schema)enable_ecs_managed_tags
(Boolean)enable_execute_command
(Boolean)group
(String)launch_type
(String)network_configuration
(Attributes) (see below for nested schema)placement_constraints
(Attributes List) (see below for nested schema)placement_strategies
(Attributes List) (see below for nested schema)platform_version
(String)propagate_tags
(String)reference_id
(String)tag_list
(Attributes List) (see below for nested schema)task_count
(Number)targets.ecs_parameters.capacity_provider_strategy
Required:
capacity_provider
(String)Optional:
base
(Number)weight
(Number)targets.ecs_parameters.network_configuration
Optional:
aws_vpc_configuration
(Attributes) (see below for nested schema)targets.ecs_parameters.network_configuration.aws_vpc_configuration
Required:
subnets
(List of String)Optional:
assign_public_ip
(String)security_groups
(List of String)targets.ecs_parameters.placement_constraints
Optional:
expression
(String)type
(String)targets.ecs_parameters.placement_strategies
Optional:
field
(String)type
(String)targets.ecs_parameters.tag_list
Optional:
key
(String)value
(String)targets.http_parameters
Optional:
header_parameters
(Map of String)path_parameter_values
(List of String)query_string_parameters
(Map of String)targets.input_transformer
Required:
input_template
(String)Optional:
input_paths_map
(Map of String)targets.kinesis_parameters
Required:
partition_key_path
(String)targets.redshift_data_parameters
Required:
database
(String)Optional:
db_user
(String)secret_manager_arn
(String)sql
(String)sqls
(List of String)statement_name
(String)with_event
(Boolean)targets.retry_policy
Optional:
maximum_event_age_in_seconds
(Number)maximum_retry_attempts
(Number)targets.run_command_parameters
Required:
run_command_targets
(Attributes List) (see below for nested schema)targets.run_command_parameters.run_command_targets
Required:
key
(String)values
(List of String)targets.sage_maker_pipeline_parameters
Optional:
pipeline_parameter_list
(Attributes List) (see below for nested schema)targets.sage_maker_pipeline_parameters.pipeline_parameter_list
Required:
name
(String)value
(String)targets.sqs_parameters
Required:
message_group_id
(String)Import is supported using the following syntax:
$ terraform import awscc_events_rule.example <resource ID>