Class Target
- Namespace
- Amazon.EventBridge.Model
- Assembly
- AWSSDK.EventBridge.dll
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 Amazon Web Services Accounts in the Amazon EventBridge
User Guide.
public class Target- Inheritance
-
Target
- Inherited Members
Constructors
Target()
public Target()Properties
AppSyncParameters
Gets and sets the property AppSyncParameters.
Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
public AppSyncParameters AppSyncParameters { get; set; }Property Value
Arn
Gets and sets the property Arn.
The Amazon Resource Name (ARN) of the target.
public string Arn { get; set; }Property Value
BatchParameters
Gets and sets the property BatchParameters.
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.
public BatchParameters BatchParameters { get; set; }Property Value
DeadLetterConfig
Gets and sets the property DeadLetterConfig.
The DeadLetterConfig that defines the target queue to send dead-letter queue
events to.
public DeadLetterConfig DeadLetterConfig { get; set; }Property Value
EcsParameters
Gets and sets the property 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.
public EcsParameters EcsParameters { get; set; }Property Value
HttpParameters
Gets and sets the property HttpParameters.
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.
public HttpParameters HttpParameters { get; set; }Property Value
Id
Gets and sets the property 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.
public string Id { get; set; }Property Value
Input
Gets and sets the property 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.
public string Input { get; set; }Property Value
InputPath
Gets and sets the property InputPath.
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.
public string InputPath { get; set; }Property Value
InputTransformer
Gets and sets the property 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.
public InputTransformer InputTransformer { get; set; }Property Value
KinesisParameters
Gets and sets the property 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.
public KinesisParameters KinesisParameters { get; set; }Property Value
RedshiftDataParameters
Gets and sets the property RedshiftDataParameters.
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.
public RedshiftDataParameters RedshiftDataParameters { get; set; }Property Value
RetryPolicy
Gets and sets the property RetryPolicy.
The RetryPolicy object that contains the retry policy configuration to use
for the dead-letter queue.
public RetryPolicy RetryPolicy { get; set; }Property Value
RoleArn
Gets and sets the property RoleArn.
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.
public string RoleArn { get; set; }Property Value
RunCommandParameters
Gets and sets the property RunCommandParameters.
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
public RunCommandParameters RunCommandParameters { get; set; }Property Value
SageMakerPipelineParameters
Gets and sets the property SageMakerPipelineParameters.
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.
public SageMakerPipelineParameters SageMakerPipelineParameters { get; set; }Property Value
SqsParameters
Gets and sets the property SqsParameters.
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.
public SqsParameters SqsParameters { get; set; }