TargetProperty Struct
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 .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const targetProperty: events.CfnRule.TargetProperty = {
arn: 'arn',
id: 'id',
// the properties below are optional
appSyncParameters: {
graphQlOperation: 'graphQlOperation',
},
batchParameters: {
jobDefinition: 'jobDefinition',
jobName: 'jobName',
// the properties below are optional
arrayProperties: {
size: 123,
},
retryStrategy: {
attempts: 123,
},
},
deadLetterConfig: {
arn: 'arn',
},
ecsParameters: {
taskDefinitionArn: 'taskDefinitionArn',
// the properties below are optional
capacityProviderStrategy: [{
capacityProvider: 'capacityProvider',
// the properties below are optional
base: 123,
weight: 123,
}],
enableEcsManagedTags: false,
enableExecuteCommand: false,
group: 'group',
launchType: 'launchType',
networkConfiguration: {
awsVpcConfiguration: {
subnets: ['subnets'],
// the properties below are optional
assignPublicIp: 'assignPublicIp',
securityGroups: ['securityGroups'],
},
},
placementConstraints: [{
expression: 'expression',
type: 'type',
}],
placementStrategies: [{
field: 'field',
type: 'type',
}],
platformVersion: 'platformVersion',
propagateTags: 'propagateTags',
referenceId: 'referenceId',
tagList: [{
key: 'key',
value: 'value',
}],
taskCount: 123,
},
httpParameters: {
headerParameters: {
headerParametersKey: 'headerParameters',
},
pathParameterValues: ['pathParameterValues'],
queryStringParameters: {
queryStringParametersKey: 'queryStringParameters',
},
},
input: 'input',
inputPath: 'inputPath',
inputTransformer: {
inputTemplate: 'inputTemplate',
// the properties below are optional
inputPathsMap: {
inputPathsMapKey: 'inputPathsMap',
},
},
kinesisParameters: {
partitionKeyPath: 'partitionKeyPath',
},
redshiftDataParameters: {
database: 'database',
// the properties below are optional
dbUser: 'dbUser',
secretManagerArn: 'secretManagerArn',
sql: 'sql',
sqls: ['sqls'],
statementName: 'statementName',
withEvent: false,
},
retryPolicy: {
maximumEventAgeInSeconds: 123,
maximumRetryAttempts: 123,
},
roleArn: 'roleArn',
runCommandParameters: {
runCommandTargets: [{
key: 'key',
values: ['values'],
}],
},
sageMakerPipelineParameters: {
pipelineParameterList: [{
name: 'name',
value: 'value',
}],
},
sqsParameters: {
messageGroupId: 'messageGroupId',
},
};
Properties
appSyncParametersIResolvable | CfnRule.AppSyncParametersPropertyapp_sync_parameterstyping.Union[IResolvable, AppSyncParametersProperty]appSyncParametersIResolvableAppSyncParametersIResolvableAppSyncParametersinterface{}#batchParametersIResolvable | CfnRule.BatchParametersPropertybatch_parameterstyping.Union[IResolvable, BatchParametersProperty]batchParametersIResolvableBatchParametersIResolvableBatchParametersinterface{}#For more information, see Jobs in the AWS Batch User Guide .
deadLetterConfigIResolvable | CfnRule.DeadLetterConfigPropertydead_letter_configtyping.Union[IResolvable, DeadLetterConfigProperty]deadLetterConfigIResolvableDeadLetterConfigIResolvableDeadLetterConfiginterface{}#ecsParametersIResolvable | CfnRule.EcsParametersPropertyecs_parameterstyping.Union[IResolvable, EcsParametersProperty]ecsParametersIResolvableEcsParametersIResolvableEcsParametersinterface{}#For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .
httpParametersIResolvable | CfnRule.HttpParametersPropertyhttp_parameterstyping.Union[IResolvable, HttpParametersProperty]httpParametersIResolvableHttpParametersIResolvableHttpParametersinterface{}#notes
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.
Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
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 .
You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath .
inputTransformerIResolvable | CfnRule.InputTransformerPropertyinput_transformertyping.Union[IResolvable, InputTransformerProperty]inputTransformerIResolvableInputTransformerIResolvableInputTransformerinterface{}#You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
kinesisParametersIResolvable | CfnRule.KinesisParametersPropertykinesis_parameterstyping.Union[IResolvable, KinesisParametersProperty]kinesisParametersIResolvableKinesisParametersIResolvableKinesisParametersinterface{}#If you do not include this parameter, the default is to use the eventId as the partition key.
redshiftDataParametersIResolvable | CfnRule.RedshiftDataParametersPropertyredshift_data_parameterstyping.Union[IResolvable, RedshiftDataParametersProperty]redshiftDataParametersIResolvableRedshiftDataParametersIResolvableRedshiftDataParametersinterface{}#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.
retryPolicyIResolvable | CfnRule.RetryPolicyPropertyretry_policytyping.Union[IResolvable, RetryPolicyProperty]retryPolicyIResolvableRetryPolicyIResolvableRetryPolicyinterface{}#If one rule triggers multiple targets, you can use a different IAM role for each target.
runCommandParametersIResolvable | CfnRule.RunCommandParametersPropertyrun_command_parameterstyping.Union[IResolvable, RunCommandParametersProperty]runCommandParametersIResolvableRunCommandParametersIResolvableRunCommandParametersinterface{}#sageMakerPipelineParametersIResolvable | CfnRule.SageMakerPipelineParametersPropertysage_maker_pipeline_parameterstyping.Union[IResolvable, SageMakerPipelineParametersProperty]sageMakerPipelineParametersIResolvableSageMakerPipelineParametersIResolvableSageMakerPipelineParametersinterface{}#If you specify a SageMaker AI Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
sqsParametersIResolvable | CfnRule.SqsParametersPropertysqs_parameterstyping.Union[IResolvable, SqsParametersProperty]sqsParametersIResolvableSqsParametersIResolvableSqsParametersinterface{}#If you specify a fair or FIFO queue as a target, the queue must have content-based deduplication enabled.