ApiDestinationProps

class aws_cdk.aws_events_targets.ApiDestinationProps(*, dead_letter_queue=None, max_event_age=None, retry_attempts=None, event=None, event_role=None, header_parameters=None, path_parameter_values=None, query_string_parameters=None)

Bases: TargetBaseProps

Customize the EventBridge Api Destinations Target.

Parameters:

  • dead_letter_queue (Optional[IQueue]) – The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue. Default: - no dead-letter queue

  • max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400. Default: Duration.hours(24)

  • retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185. Default: 185

  • event (Optional[RuleTargetInput]) – The event to send. Default: - the entire EventBridge event

  • event_role (Optional[IRole]) – The role to assume before invoking the target. Default: - a new role will be created

  • header_parameters (Optional[Mapping[str, str]]) – Additional headers sent to the API Destination. These are merged with headers specified on the Connection, with the headers on the Connection taking precedence. You can only specify secret values on the Connection. Default: - none

  • path_parameter_values (Optional[Sequence[str]]) – Path parameters to insert in place of path wildcards (*). If the API destination has a wilcard in the path, these path parts will be inserted in that place. Default: - none

  • query_string_parameters (Optional[Mapping[str, str]]) – Additional query string parameters sent to the API Destination. These are merged with headers specified on the Connection, with the headers on the Connection taking precedence. You can only specify secret values on the Connection. Default: - none

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_events as events
from aws_cdk import aws_events_targets as events_targets
from aws_cdk import aws_iam as iam
from aws_cdk import aws_sqs as sqs

# queue: sqs.Queue
# role: iam.Role
# rule_target_input: events.RuleTargetInput

api_destination_props = events_targets.ApiDestinationProps(
    dead_letter_queue=queue,
    event=rule_target_input,
    event_role=role,
    header_parameters={
        "header_parameters_key": "headerParameters"
    },
    max_event_age=cdk.Duration.minutes(30),
    path_parameter_values=["pathParameterValues"],
    query_string_parameters={
        "query_string_parameters_key": "queryStringParameters"
    },
    retry_attempts=123
)

Attributes

dead_letter_queue

//docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations>`_.

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default:

  • no dead-letter queue

Type:

The SQS queue to be used as deadLetterQueue. Check out the `considerations for using a dead-letter queue <https

event

The event to send.

Default:

  • the entire EventBridge event

event_role

The role to assume before invoking the target.

Default:

  • a new role will be created

header_parameters

Additional headers sent to the API Destination.

These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.

You can only specify secret values on the Connection.

Default:

  • none

max_event_age

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default:

Duration.hours(24)

path_parameter_values

Path parameters to insert in place of path wildcards (*).

If the API destination has a wilcard in the path, these path parts will be inserted in that place.

Default:

  • none

query_string_parameters

Additional query string parameters sent to the API Destination.

These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.

You can only specify secret values on the Connection.

Default:

  • none

retry_attempts

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default:

185