Target class

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

Constructors

Target({required String arn, required String id, BatchParameters? batchParameters, DeadLetterConfig? deadLetterConfig, EcsParameters? ecsParameters, HttpParameters? httpParameters, String? input, String? inputPath, InputTransformer? inputTransformer, KinesisParameters? kinesisParameters, RedshiftDataParameters? redshiftDataParameters, RetryPolicy? retryPolicy, String? roleArn, RunCommandParameters? runCommandParameters, SqsParameters? sqsParameters})
Target.fromJson(Map<String, dynamic> json)
factory

Properties

arn → String
The Amazon Resource Name (ARN) of the target.
final
batchParameters → BatchParameters?
If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.
final
deadLetterConfig → DeadLetterConfig?
The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
final
ecsParameters → EcsParameters?
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.
final
hashCode → int
The hash code for this object.
no setterinherited
httpParameters → HttpParameters?
Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.
final
id → String
The ID of the target.
final
input → String?
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.
final
inputPath → String?
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
final
inputTransformer → InputTransformer?
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.
final
kinesisParameters → KinesisParameters?
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.
final
redshiftDataParameters → RedshiftDataParameters?
Contains the Redshift Data API parameters to use when the target is a Redshift cluster.
final
retryPolicy → RetryPolicy?
The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
final
roleArn → String?
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.
final
runCommandParameters → RunCommandParameters?
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sqsParameters → SqsParameters?
Contains the message group ID to use when the target is a FIFO queue.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited