aws_eventbridge_rule_target

account_id

Type: STRING

app_sync_parameters

Type: STRUCT
Provider name: AppSyncParameters
Description: Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

• graph_ql_operation
  Type: STRING
  Provider name: GraphQLOperation
  Description: 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

Type: STRING
Provider name: Arn
Description: The Amazon Resource Name (ARN) of the target.

batch_parameters

Type: STRUCT
Provider name: BatchParameters
Description: 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.

• array_properties
  Type: STRUCT
  Provider name: ArrayProperties
  Description: 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.
  
  • size
    Type: INT32
    Provider name: Size
    Description: The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
    
• job_definition
  Type: STRING
  Provider name: JobDefinition
  Description: The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
  
• job_name
  Type: STRING
  Provider name: JobName
  Description: The name to use for this execution of the job, if the target is an Batch job.
  
• retry_strategy
  Type: STRUCT
  Provider name: RetryStrategy
  Description: 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.
  
  • attempts
    Type: INT32
    Provider name: Attempts
    Description: The number of times to attempt to retry, if the job fails. Valid values are 1–10.
    

dead_letter_config

Type: STRUCT
Provider name: DeadLetterConfig
Description: The DeadLetterConfig that defines the target queue to send dead-letter queue events to.

• arn
  Type: STRING
  Provider name: Arn
  Description: The ARN of the SQS queue specified as the target for the dead-letter queue.
  

ecs_parameters

Type: STRUCT
Provider name: EcsParameters
Description: 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.

• capacity_provider_strategy
  Type: UNORDERED_LIST_STRUCT
  Provider name: CapacityProviderStrategy
  Description: The capacity provider strategy to use for the task. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
  
  • base
    Type: INT32
    Provider name: base
    Description: 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.
    
  • capacity_provider
    Type: STRING
    Provider name: capacityProvider
    Description: The short name of the capacity provider.
    
  • weight
    Type: INT32
    Provider name: weight
    Description: 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.
    
• enable_ecs_managed_tags
  Type: BOOLEAN
  Provider name: EnableECSManagedTags
  Description: 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.
  
• enable_execute_command
  Type: BOOLEAN
  Provider name: EnableExecuteCommand
  Description: 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.
  
• group
  Type: STRING
  Provider name: Group
  Description: Specifies an ECS task group for the task. The maximum length is 255 characters.
  
• launch_type
  Type: STRING
  Provider name: LaunchType
  Description: 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.
  
• network_configuration
  Type: STRUCT
  Provider name: NetworkConfiguration
  Description: 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.
  
  • awsvpc_configuration
    Type: STRUCT
    Provider name: awsvpcConfiguration
    Description: 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.
    
    • assign_public_ip
      Type: STRING
      Provider name: AssignPublicIp
      Description: 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.
      
    • security_groups
      Type: UNORDERED_LIST_STRING
      Provider name: SecurityGroups
      Description: Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
      
    • subnets
      Type: UNORDERED_LIST_STRING
      Provider name: Subnets
      Description: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
      
• placement_constraints
  Type: UNORDERED_LIST_STRUCT
  Provider name: PlacementConstraints
  Description: An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
  
  • expression
    Type: STRING
    Provider name: expression
    Description: 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.
    
  • type
    Type: STRING
    Provider name: type
    Description: 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.
    
• placement_strategy
  Type: UNORDERED_LIST_STRUCT
  Provider name: PlacementStrategy
  Description: The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
  
  • field
    Type: STRING
    Provider name: field
    Description: 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.
    
  • type
    Type: STRING
    Provider name: type
    Description: 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).
    
• platform_version
  Type: STRING
  Provider name: PlatformVersion
  Description: 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.
  
• propagate_tags
  Type: STRING
  Provider name: PropagateTags
  Description: 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.
  
• reference_id
  Type: STRING
  Provider name: ReferenceId
  Description: The reference ID to use for the task.
  
• task_count
  Type: INT32
  Provider name: TaskCount
  Description: The number of tasks to create based on TaskDefinition. The default is 1.
  
• task_definition_arn
  Type: STRING
  Provider name: TaskDefinitionArn
  Description: The ARN of the task definition to use if the event target is an Amazon ECS task.
  

http_parameters

Type: STRUCT
Provider name: HttpParameters
Description: 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.

• header_parameters
  Type: MAP_STRING_STRING
  Provider name: HeaderParameters
  Description: The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
  
• path_parameter_values
  Type: UNORDERED_LIST_STRING
  Provider name: PathParameterValues
  Description: The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
  
• query_string_parameters
  Type: MAP_STRING_STRING
  Provider name: QueryStringParameters
  Description: The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
  

id

Type: STRING
Provider name: Id
Description: 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.

input

Type: STRING
Provider name: Input
Description: 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.

input_path

Type: STRING
Provider name: InputPath
Description: 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.

input_transformer

Type: STRUCT
Provider name: InputTransformer
Description: 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.

• input_paths_map
  Type: MAP_STRING_STRING
  Provider name: InputPathsMap
  Description: 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_template
  Type: STRING
  Provider name: InputTemplate
  Description: 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 placeholder cannot be used as an object key.
  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

Type: STRUCT
Provider name: KinesisParameters
Description: 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.

• partition_key_path
  Type: STRING
  Provider name: PartitionKeyPath
  Description: 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

Type: STRUCT
Provider name: RedshiftDataParameters
Description: 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.

• database
  Type: STRING
  Provider name: Database
  Description: The name of the database. Required when authenticating using temporary credentials.
  
• db_user
  Type: STRING
  Provider name: DbUser
  Description: The database user name. Required when authenticating using temporary credentials.
  
• secret_manager_arn
  Type: STRING
  Provider name: SecretManagerArn
  Description: The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
  
• sql
  Type: STRING
  Provider name: Sql
  Description: The SQL statement text to run.
  
• sqls
  Type: UNORDERED_LIST_STRING
  Provider name: Sqls
  Description: One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don’t start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.
  
• statement_name
  Type: STRING
  Provider name: StatementName
  Description: The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
  
• with_event
  Type: BOOLEAN
  Provider name: WithEvent
  Description: Indicates whether to send an event back to EventBridge after the SQL statement runs.
  

retry_policy

Type: STRUCT
Provider name: RetryPolicy
Description: The retry policy configuration to use for the dead-letter queue.

• maximum_event_age_in_seconds
  Type: INT32
  Provider name: MaximumEventAgeInSeconds
  Description: The maximum amount of time, in seconds, to continue to make retry attempts.
  
• maximum_retry_attempts
  Type: INT32
  Provider name: MaximumRetryAttempts
  Description: 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

Type: STRING
Provider name: RoleArn
Description: 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.

run_command_parameters

Type: STRUCT
Provider name: RunCommandParameters
Description: Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

• run_command_targets
  Type: UNORDERED_LIST_STRUCT
  Provider name: RunCommandTargets
  Description: Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
  
  • key
    Type: STRING
    Provider name: Key
    Description: Can be either tag: tag-key or InstanceIds.
    
  • values
    Type: UNORDERED_LIST_STRING
    Provider name: Values
    Description: If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.
    

sage_maker_pipeline_parameters

Type: STRUCT
Provider name: SageMakerPipelineParameters
Description: 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.

• pipeline_parameter_list
  Type: UNORDERED_LIST_STRUCT
  Provider name: PipelineParameterList
  Description: List of Parameter names and values for SageMaker Model Building Pipeline execution.
  
  • name
    Type: STRING
    Provider name: Name
    Description: Name of parameter to start execution of a SageMaker Model Building Pipeline.
    
  • value
    Type: STRING
    Provider name: Value
    Description: Value of parameter to start execution of a SageMaker Model Building Pipeline.
    

sqs_parameters

Type: STRUCT
Provider name: SqsParameters
Description: 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.

• message_group_id
  Type: STRING
  Provider name: MessageGroupId
  Description: The FIFO message group ID to use as the target.
  

tags

Type: UNORDERED_LIST_STRING