RuleTargetConfig

class aws_cdk.aws_events.RuleTargetConfig(*, arn, batch_parameters=None, dead_letter_config=None, ecs_parameters=None, http_parameters=None, id=None, input=None, kinesis_parameters=None, retry_policy=None, role=None, run_command_parameters=None, sqs_parameters=None, target_resource=None)

Bases: object

Properties for an event rule target.

Parameters

  • arn (str) – The Amazon Resource Name (ARN) of the target.

  • batch_parameters (Optional[BatchParametersProperty]) – Parameters used when the rule invokes Amazon AWS Batch Job/Queue. Default: no parameters set

  • dead_letter_config (Optional[DeadLetterConfigProperty]) – Contains information about a dead-letter queue configuration. Default: no dead-letter queue set

  • ecs_parameters (Optional[EcsParametersProperty]) – The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.

  • http_parameters (Optional[HttpParametersProperty]) – Parameters used when the rule invoke api gateway.

  • id (Optional[str]) – (deprecated) A unique, user-defined identifier for the target. Acceptable values include alphanumeric characters, periods (.), hyphens (-), and underscores (_). Default: - an auto-generated id

  • input (Optional[RuleTargetInput]) – What input to send to the event target. Default: the entire event

  • kinesis_parameters (Optional[KinesisParametersProperty]) – Settings that control shard assignment, when the target is a Kinesis stream. If you don’t include this parameter, eventId is used as the partition key.

  • retry_policy (Optional[RetryPolicyProperty]) – A RetryPolicy object that includes information about the retry policy settings. Default: EventBridge default retry policy

  • role (Optional[IRole]) – Role to use to invoke this event target.

  • run_command_parameters (Optional[RunCommandParametersProperty]) – Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.

  • sqs_parameters (Optional[SqsParametersProperty]) – Parameters used when the FIFO sqs queue is used an event target by the rule.

  • target_resource (Optional[IConstruct]) – The resource that is backing this target. This is the resource that will actually have some action performed on it when used as a target (for example, start a build for a CodeBuild project). We need it to determine whether the rule belongs to a different account than the target - if so, we generate a more complex setup, including an additional stack containing the EventBusPolicy. Default: the target is not backed by any resource

Attributes

arn

The Amazon Resource Name (ARN) of the target.

Return type

str

batch_parameters

Parameters used when the rule invokes Amazon AWS Batch Job/Queue.

Default

no parameters set

Return type

Optional[BatchParametersProperty]

dead_letter_config

Contains information about a dead-letter queue configuration.

Default

no dead-letter queue set

Return type

Optional[DeadLetterConfigProperty]

ecs_parameters

The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task.

Return type

Optional[EcsParametersProperty]

http_parameters

Parameters used when the rule invoke api gateway.

Return type

Optional[HttpParametersProperty]

id

(deprecated) A unique, user-defined identifier for the target.

Acceptable values include alphanumeric characters, periods (.), hyphens (-), and underscores (_).

Default

  • an auto-generated id

Deprecated

no replacement. we will always use an autogenerated id.

Stability

deprecated

Return type

Optional[str]

input

What input to send to the event target.

Default

the entire event

Return type

Optional[RuleTargetInput]

kinesis_parameters

Settings that control shard assignment, when the target is a Kinesis stream.

If you don’t include this parameter, eventId is used as the partition key.

Return type

Optional[KinesisParametersProperty]

retry_policy

A RetryPolicy object that includes information about the retry policy settings.

Default

EventBridge default retry policy

Return type

Optional[RetryPolicyProperty]

role

Role to use to invoke this event target.

Return type

Optional[IRole]

run_command_parameters

Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command.

Return type

Optional[RunCommandParametersProperty]

sqs_parameters

Parameters used when the FIFO sqs queue is used an event target by the rule.

Return type

Optional[SqsParametersProperty]

target_resource

The resource that is backing this target.

This is the resource that will actually have some action performed on it when used as a target (for example, start a build for a CodeBuild project). We need it to determine whether the rule belongs to a different account than the target - if so, we generate a more complex setup, including an additional stack containing the EventBusPolicy.

Default

the target is not backed by any resource

See

https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html

Return type

Optional[IConstruct]