AWS eventbridge: Editorial rewording of EventBridge API destinations guide
Summary
Reworded prose throughout the API destinations page for clarity (HTTPS endpoint description, retry/timeout wording, Retry-After header, dead-letter queue guidance, service-linked role permissions) and added a cross-reference link to creating rules with API destination targets. No technical or behavioral changes.
Security assessment
The diff is purely editorial rewording of existing content. The service-linked role paragraph still describes least-privilege permissions but is a rephrase of pre-existing text, not new security guidance, and no vulnerability, CVE, or configuration change is introduced.
Evidence
+When you create a connection for an API destination, the service-linked role [AmazonEventBridgeApiDestinationsServiceRolePolicy](./eb-use-identity-based.html#api-destination-slr-policy) is added to your account. EventBridge uses this service-linked role to create and store a secret in Secrets Manager. To grant the necessary permissions to the service-linked role, EventBridge attaches the **AmazonEventBridgeApiDestinationsServiceRolePolicy** policy to the role. The policy grants only the permissions the role needs to work with the connection secret. No other permissions are included. The role can work only with the connections in your account.
Diff
diff --git a/eventbridge/latest/userguide/eb-api-destinations.md b/eventbridge/latest/userguide/eb-api-destinations.md index 2b42cd2..04b5f51 100644 --- a//eventbridge/latest/userguide/eb-api-destinations.md +++ b//eventbridge/latest/userguide/eb-api-destinations.md @@ -11 +11 @@ Service-linked roleHeaders in requestsAPI destination error codesInvocation rate -EventBridge _API destinations_ are HTTPS endpoints that you can invoke as the target of an event bus rule, or pipe, similar to how you invoke an AWS service or resource as a target. Using API destinations, you can route [events](./eb-events.html) between AWS services, integrated software as a service (SaaS) applications, and public or private applications by using API calls. +EventBridge _API destinations_ are HTTPS endpoints. You can invoke one as the target of an event bus rule or pipe, just as you invoke an AWS service or resource. With API destinations, you route [events](./eb-events.html) between AWS services, SaaS applications, and public or private applications. The events travel as API calls. @@ -17 +17 @@ The examples on this page use rules. A Custom Event Bus subscriber uses the same -When you specify an API destination as a rule or pipe target, EventBridge invokes the HTTPS endpoint for any event that matches the [event pattern](./eb-event-patterns.html) specified in the rule or pipe and then delivers the event information with the request. With EventBridge, you can use any HTTP method except CONNECT and TRACE for the request. The most common HTTP methods to use are PUT and POST. +When you specify an API destination as a rule or pipe target, EventBridge invokes the HTTPS endpoint for any event that matches the [event pattern](./eb-event-patterns.html) in the rule or pipe. It then delivers the event information with the request. With EventBridge, you can use any HTTP method except CONNECT and TRACE for the request. The most common HTTP methods to use are PUT and POST. @@ -19 +19,3 @@ When you specify an API destination as a rule or pipe target, EventBridge invoke -You can also use input transformers to customize the event to the parameters of a specific HTTP endpoint parameters. For more information, see [Amazon EventBridge input transformation](./eb-transform-target-input.html). +You can also use input transformers to shape the event to fit a specific HTTP endpoint. For more information, see [Amazon EventBridge input transformation](./eb-transform-target-input.html). + +To create a rule that sends events to an API destination, see [Creating rules with API destination targets](./eb-create-rule-api-destination-target.html). @@ -31 +33 @@ EventBridge API destinations currently only support public domain names with pub -EventBridge requests to an API destination endpoint must have a maximum client execution timeout of 5 seconds. If the target endpoint takes longer than 5 seconds to respond, EventBridge times out the request. EventBridge retries timed out requests up to the maximums that are configured on your retry policy. +EventBridge requests to an API destination endpoint must have a maximum client execution timeout of 5 seconds. If the target endpoint takes longer than 5 seconds to respond, EventBridge times out the request. EventBridge retries timed-out requests. Your retry policy sets the maximums. @@ -35 +37 @@ EventBridge requests to an API destination endpoint must have a maximum client e - * For pipes, retries are determined the pipe source type and its configuration. EventBridge will retry until the event expires from the source, or the maximum event age or retry attempts configured has reached. + * For pipes, the source type and its configuration determine the retries. EventBridge retries until the event expires from the source, or until it reaches the maximum event age or retry attempts. @@ -46 +48 @@ The following video demonstrates the use of API destinations: -When you create a connection for an API destination, the service-linked role [AmazonEventBridgeApiDestinationsServiceRolePolicy](./eb-use-identity-based.html#api-destination-slr-policy) is added to your account. EventBridge uses this service-linked role to create and store a secret in Secrets Manager. To grant the necessary permissions to the service-linked role, EventBridge attaches the **AmazonEventBridgeApiDestinationsServiceRolePolicy** policy to the role. The policy limits the permissions granted to only those necessary for the role to interact with the secret for the connection. No other permissions are included, and the role can interact only with the connections in your account to manage the secret. +When you create a connection for an API destination, the service-linked role [AmazonEventBridgeApiDestinationsServiceRolePolicy](./eb-use-identity-based.html#api-destination-slr-policy) is added to your account. EventBridge uses this service-linked role to create and store a secret in Secrets Manager. To grant the necessary permissions to the service-linked role, EventBridge attaches the **AmazonEventBridgeApiDestinationsServiceRolePolicy** policy to the role. The policy grants only the permissions the role needs to work with the connection secret. No other permissions are included. The role can work only with the connections in your account. @@ -163 +165 @@ When EventBridge tries to deliver an event to an API destination and an error oc -EventBridge API destinations read the standard HTTP response header `Retry-After` to find out how long to wait before making a follow-up request. For event buses, EventBridge chooses the more conservative value between the defined retry policy and the `Retry-After` header. If `Retry-After` value is negative, EventBridge stops retrying delivery for that event. +EventBridge API destinations read the standard HTTP response header `Retry-After` to learn how long to wait before the next request. For event buses, EventBridge chooses the more conservative value between the defined retry policy and the `Retry-After` header. If `Retry-After` value is negative, EventBridge stops retrying delivery for that event. @@ -167 +169 @@ EventBridge API destinations read the standard HTTP response header `Retry-After -If you set the invocation rate per second to a value much lower than the number of invocations generated, events may not be delivered within the 24 hour retry time for events. For example, if you set the invocation rate to 10 invocations per second, but thousands of events per second are generated, you will quickly have a backlog of events to deliver that exceeds 24 hours. To ensure that no events are lost, set up a dead-letter queue to send events with failed invocations to so you can process the events at a later time. For more information, see [Using dead-letter queues to process undelivered events in EventBridge](./eb-rule-dlq.html). +If you set the invocation rate per second much lower than the number of invocations generated, events may not be delivered within the 24-hour retry window. For example, suppose you set the invocation rate to 10 per second, but thousands of events arrive each second. You will quickly build a backlog that exceeds 24 hours. To avoid losing events, set up a dead-letter queue for the failed invocations. You can process those events later. For more information, see [Using dead-letter queues to process undelivered events in EventBridge](./eb-rule-dlq.html).