| Column Name | Column Data Type |
|---|
rule Required Input Column
The name of the rule. | VARCHAR |
event_bus_name Input Column
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
app_sync_parameters
Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API. | STRUCT(
"graph_ql_operation" VARCHAR
) |
Show child fields- app_sync_parameters.graph_ql_operation
The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service. For more information, see Operations in the AppSync User Guide.
|
arn
The Amazon Resource Name (ARN) of the target. | VARCHAR |
batch_parameters
If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide. | STRUCT(
"job_definition" VARCHAR,
"job_name" VARCHAR,
"array_properties" STRUCT(
"size" BIGINT
),
"retry_strategy" STRUCT(
"attempts" BIGINT
)
) |
Show child fields- batch_parameters.array_properties
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job. Show child fields- batch_parameters.array_properties.size
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
- batch_parameters.job_definition
The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist. - batch_parameters.job_name
The name to use for this execution of the job, if the target is an Batch job. - batch_parameters.retry_strategy
The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition. Show child fields- batch_parameters.retry_strategy.attempts
The number of times to attempt to retry, if the job fails. Valid values are 1–10.
|
dead_letter_config
The DeadLetterConfig that defines the target queue to send dead-letter queue events to. | STRUCT(
"arn" VARCHAR
) |
Show child fields- dead_letter_config.arn
The ARN of the SQS queue specified as the target for the dead-letter queue.
|
ecs_parameters
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide. | STRUCT(
"task_definition_arn" VARCHAR,
"task_count" BIGINT,
"launch_type" VARCHAR,
"network_configuration" STRUCT(
"awsvpc_configuration" STRUCT(
"subnets" VARCHAR[],
"security_groups" VARCHAR[],
"assign_public_ip" VARCHAR
)
),
"platform_version" VARCHAR,
"group" VARCHAR,
"capacity_provider_strategy" STRUCT(
"capacity_provider" VARCHAR,
"weight" BIGINT,
"base" BIGINT
)[],
"enable_ecs_managed_tags" BOOLEAN,
"enable_execute_command" BOOLEAN,
"placement_constraints" STRUCT(
"type" VARCHAR,
"expression" VARCHAR
)[],
"placement_strategy" STRUCT(
"type" VARCHAR,
"field" VARCHAR
)[],
"propagate_tags" VARCHAR,
"reference_id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
) |
Show child fields- ecs_parameters.capacity_provider_strategy[]
Show child fields- ecs_parameters.capacity_provider_strategy[].base
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. - ecs_parameters.capacity_provider_strategy[].capacity_provider
The short name of the capacity provider. - ecs_parameters.capacity_provider_strategy[].weight
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
- ecs_parameters.enable_ecs_managed_tags
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. - ecs_parameters.enable_execute_command
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task. - ecs_parameters.group
Specifies an ECS task group for the task. The maximum length is 255 characters. - ecs_parameters.launch_type
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide. - ecs_parameters.network_configuration
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails. Show child fields- ecs_parameters.network_configuration.awsvpc_configuration
Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. Show child fields- ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE. - ecs_parameters.network_configuration.awsvpc_configuration.security_groups[]
- ecs_parameters.network_configuration.awsvpc_configuration.subnets[]
- ecs_parameters.placement_constraints[]
Show child fields- ecs_parameters.placement_constraints[].expression
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. - ecs_parameters.placement_constraints[].type
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
- ecs_parameters.placement_strategy[]
Show child fields- ecs_parameters.placement_strategy[].field
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. - ecs_parameters.placement_strategy[].type
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
- ecs_parameters.platform_version
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. - ecs_parameters.propagate_tags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action. - ecs_parameters.reference_id
The reference ID to use for the task. - ecs_parameters.tags[]
Show child fields- ecs_parameters.tags[].key
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. - ecs_parameters.tags[].value
The value for the specified tag key.
- ecs_parameters.task_count
The number of tasks to create based on TaskDefinition. The default is 1. - ecs_parameters.task_definition_arn
The ARN of the task definition to use if the event target is an Amazon ECS task.
|
http_parameters
Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination. If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence. | STRUCT(
"path_parameter_values" VARCHAR[],
"header_parameters" MAP(VARCHAR, VARCHAR),
"query_string_parameters" MAP(VARCHAR, VARCHAR)
) |
Show child fields- http_parameters.header_parameters
The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination. - http_parameters.path_parameter_values[]
- http_parameters.query_string_parameters
The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
|
id
The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string. | VARCHAR |
input
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format. | VARCHAR |
input_path
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath. | VARCHAR |
input_transformer
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target. | STRUCT(
"input_paths_map" MAP(VARCHAR, VARCHAR),
"input_template" VARCHAR
) |
Show child fields- input_transformer.input_paths_map
Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target. InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation. The keys cannot start with "Amazon Web Services." - input_transformer.input_template
Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply: The following example shows the syntax for using InputPathsMap and InputTemplate. "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "<instance> is in state <status>" } To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example: "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": "<instance> is in state \"<status>\"" } The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example: "InputTransformer": { "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"}, "InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}' }
|
kinesis_parameters
The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key. | STRUCT(
"partition_key_path" VARCHAR
) |
Show child fields- kinesis_parameters.partition_key_path
The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
|
redshift_data_parameters
Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster. If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events. | STRUCT(
"secret_manager_arn" VARCHAR,
"database" VARCHAR,
"db_user" VARCHAR,
"sql" VARCHAR,
"statement_name" VARCHAR,
"with_event" BOOLEAN,
"sqls" VARCHAR[]
) |
Show child fields- redshift_data_parameters.database
The name of the database. Required when authenticating using temporary credentials. - redshift_data_parameters.db_user
The database user name. Required when authenticating using temporary credentials. - redshift_data_parameters.secret_manager_arn
The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager. - redshift_data_parameters.sql
The SQL statement text to run. - redshift_data_parameters.sqls[]
- redshift_data_parameters.statement_name
The name of the SQL statement. You can name the SQL statement when you create it to identify the query. - redshift_data_parameters.with_event
Indicates whether to send an event back to EventBridge after the SQL statement runs.
|
retry_policy
The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue. | STRUCT(
"maximum_retry_attempts" BIGINT,
"maximum_event_age_in_seconds" BIGINT
) |
Show child fields- retry_policy.maximum_event_age_in_seconds
The maximum amount of time, in seconds, to continue to make retry attempts. - retry_policy.maximum_retry_attempts
The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is met.
|
role_arn
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target. | VARCHAR |
run_command_parameters
Parameters used when you are using the rule to invoke Amazon EC2 Run Command. | STRUCT(
"run_command_targets" STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[]
) |
Show child fields- run_command_parameters.run_command_targets[]
Show child fields- run_command_parameters.run_command_targets[].key
Can be either tag: tag-key or InstanceIds. - run_command_parameters.run_command_targets[].values[]
|
sage_maker_pipeline_parameters
Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline. If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events. | STRUCT(
"pipeline_parameter_list" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[]
) |
Show child fields- sage_maker_pipeline_parameters.pipeline_parameter_list[]
Show child fields- sage_maker_pipeline_parameters.pipeline_parameter_list[].name
Name of parameter to start execution of a SageMaker Model Building Pipeline. - sage_maker_pipeline_parameters.pipeline_parameter_list[].value
Value of parameter to start execution of a SageMaker Model Building Pipeline.
|
sqs_parameters
Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled. | STRUCT(
"message_group_id" VARCHAR
) |
Show child fields- sqs_parameters.message_group_id
The FIFO message group ID to use as the target.
|