AWS rtb-fabric documentation change
Summary
Updated terminology from 'gateway' to 'RTB Fabric user' and 'application' to 'gateway'. Expanded external links documentation with routing details, client IP preservation, opt-in requirements, and CLI examples. Added sections for creating inbound/outbound external links with AWS CLI commands and responses.
Security assessment
The changes add documentation about security features including secure connections, client IP preservation in external links, and differences in security characteristics when using public internet routing. However, there's no evidence of addressing a specific vulnerability or incident. The added security documentation helps users understand implications of external routing.
Diff
diff --git a/rtb-fabric/latest/userguide/links.md b/rtb-fabric/latest/userguide/links.md index 62749d111..5cf48d852 100644 --- a//rtb-fabric/latest/userguide/links.md +++ b//rtb-fabric/latest/userguide/links.md @@ -5 +5 @@ -Creating links between gatewaysTesting and using linksCreating external linksEditing linksAccepting or declining a link requestDeleting gateway linksAdding modules to linksConfiguring link logging +Creating links between RTB Fabric usersTesting and using linksCreating external linksEditing linksAccepting or declining a link requestDeleting linksAdding modules to linksConfiguring link logging @@ -9 +9 @@ Creating links between gatewaysTesting and using linksCreating external linksEdi -RTB Fabric links establish secure connections between your requester gateways and responder gateways in your real-time bidding infrastructure. Links can be between RTB Fabric users, or between an RTB Fabric user and an external entity (external links). These links enable seamless data flow and communication between gateways, allowing your applications to build comprehensive bidding workflows through RTB Fabric infrastructure. +RTB Fabric links provide secure, performant one-to-one connections between requesters and responders for real-time bidding. Links can be established between two RTB Fabric users (such as between your application and one of your real-time bidding partners that also uses RTB Fabric), or between an RTB Fabric user and an entity outside RTB Fabric, known as external links. These connections form the foundation of your real-time bidding network infrastructure, enabling secure and efficient data exchange between all participants. @@ -13 +13 @@ RTB Fabric links establish secure connections between your requester gateways an -To create links with other RTB Fabric users, you need their responder gateway ID. Contact your RTB Fabric partners directly to exchange gateway IDs. AWS does not provide gateway IDs for external partners, so coordinate directly with your business partners to obtain this information. +To create links with other RTB Fabric users, you must first obtain their gateway ID. Contact your business partners directly to exchange gateway IDs, as AWS does not distribute this information. @@ -17 +17 @@ To create links with other RTB Fabric users, you need their responder gateway ID - * Creating links between gateways + * Creating links between RTB Fabric users @@ -27 +27 @@ To create links with other RTB Fabric users, you need their responder gateway ID - * Deleting gateway links + * Deleting links @@ -36 +36 @@ To create links with other RTB Fabric users, you need their responder gateway ID -## Creating links between gateways +## Creating links between RTB Fabric users @@ -38 +38 @@ To create links with other RTB Fabric users, you need their responder gateway ID -You can create links between RTB Fabric gateways through the AWS Management Console. Only requester gateways can initiate link creation to connect with responder gateways in the system. +Links between RTB Fabric users can be created through the AWS Management Console, the AWS CLI, or AWS CloudFormation. Only requester gateways can initiate links to responder gateways. @@ -46 +46 @@ You can create links between RTB Fabric gateways through the AWS Management Cons - 3. Select an RTB application from the list. + 3. Select a gateway from the list. @@ -48 +48 @@ You can create links between RTB Fabric gateways through the AWS Management Cons - 4. On the application details page, choose the **Associated links** tab. + 4. On the gateway details page, choose the **Associated links** tab. @@ -70,3 +70 @@ Note the following: - * AWS does not access or read your log data. - - * Range must be from 0.0-100.0. + * Logs are delivered via Amazon CloudWatch Vended Logs, which provides delivery directly to Amazon S3, Amazon Data Firehose, or Amazon CloudWatch Logs. @@ -76 +74,3 @@ Note the following: - 9. In the **Target details** section, enter the **Target gateway ID** of the target gateway you want to link with. Enter a valid gateway ID (for example: `rtb-gw-q6jlbximmmnaz1q5676wots4xy`). + * AWS does not access or read your log data. + + 9. In the **Target details** section, enter the **Target gateway ID** of the target gateway you want to link with. Enter a valid gateway ID (for example: `rtb-gw-source123`). @@ -89 +89 @@ Contact your RTB Fabric partner to obtain their gateway ID. AWS does not provide -Once the target application accepts the link request, the link status changes to **Active** and begins facilitating communication between your RTB applications. You can monitor link performance and make configuration changes as needed. +Once the target gateway accepts the link request, the link status changes to **Active** and begins facilitating communication between your gateways. You can monitor link performance and make configuration changes as needed. @@ -92,0 +93,2 @@ Use the following command to create a link between gateways using the AWS Comman +**Create a basic link between gateways** + @@ -94,2 +96 @@ Use the following command to create a link between gateways using the AWS Comman - # Create a basic link between gateways - aws rtbfabric create-link \ + $ aws rtbfabric create-link \ @@ -98,8 +99,5 @@ Use the following command to create a link between gateways using the AWS Comman - --log-settings '{ - "applicationLogs": { - "sampling": { - "errorLog": 100.0, - "filterLog": 0.0 - } - } - }' + --log-settings '{"applicationLogs":{"sampling":{"errorLog":100.0,"filterLog":0}}}' \ + --endpoint-url https://rtbfabric.us-east-1.amazonaws.com \ + --region us-east-1 + +**Create a link with customer-provided ID and tags** @@ -107,2 +105,2 @@ Use the following command to create a link between gateways using the AWS Comman - # Create a link with customer-provided ID and tags - aws rtbfabric create-link \ + + $ aws rtbfabric create-link \ @@ -112,9 +110,4 @@ Use the following command to create a link between gateways using the AWS Comman - --log-settings '{ - "applicationLogs": { - "sampling": { - "errorLog": 100.0, - "filterLog": 0.0 - } - } - }' \ - --tags Environment=Production Team=RTB + --log-settings '{"applicationLogs":{"sampling":{"errorLog":100.0,"filterLog":0}}}' \ + --tags '{"Environment": "Production", "Team": "RTB"}' \ + --endpoint-url https://rtbfabric.us-east-1.amazonaws.com \ + --region us-east-1 @@ -135,2 +128 @@ Link addresses will only be visible and accessible from within your VPC. - "https://rtb-gw-{your-gateway-id}.{your-aws-account}.gateway.rtbfabric.us-east-1.amazonaws.com/link/link-{your-link-id}/link" - + "https://{your-gateway-id}.{your-aws-account}.gateway.rtbfabric.{your-region}.amazonaws.com/link/{your-link-id}" @@ -145 +137,20 @@ Any additional URL or path params that your partner expects can be appended to t -Using the AWS Management Console, you can create outbound external links in your RTB Fabric requester gateway. Outbound external links allow connectivity with external responders (such as DSPs). +External links enable connectivity between your RTB Fabric gateways and external partners using the AWS Global Network or public internet, extending your RTB infrastructure beyond private VPC connections. This feature supports integration with external supply-side platforms (SSPs), demand-side platforms (DSPs), and other RTB partners who are not using RTB Fabric infrastructure. + +External links differ from standard RTB Fabric links in several key ways: + + * **External routing** – Traffic is routed over the AWS Global Network when possible, and the public internet when required to reach external endpoints. + + * **Client IP preservation** – In inbound external links, the original client IP addresses are preserved, enabling DSPs to implement IP-based filtering and geographic targeting. + + * **Opt-in feature** – External link capability must be explicitly enabled for your account. Use the Service Quotas tool to request access to external link functionality. + + * **Limited console support** – While outbound external links can be created through the console, API, AWS CLI, or AWS CloudFormation, inbound external links can only be created and managed through the RTB Fabric API, AWS CLI, or AWS CloudFormation. + + + + +Use inbound external links to receive traffic from external partners, and outbound external links to send traffic to external endpoints. For more information, see [CreateInboundExternalLink](https://docs.aws.amazon.com/rtb-fabric/latest/api/API_CreateInboundExternalLink.html) and [CreateOutboundExternalLink](https://docs.aws.amazon.com/rtb-fabric/latest/api/API_CreateOutboundExternalLink.html) in the _RTB Fabric API Reference_. + +### Creating outbound external links + +Outbound external links allow your requester gateway to send traffic to external partner endpoints (such as DSPs) using optimized routing over the AWS Global Network where possible, falling back to public internet routing when required. You must provide the public HTTP or HTTPS endpoint URL of the external responder. You can create outbound external links using the AWS Management Console, the RTB Fabric API, the AWS CLI, or AWS CloudFormation. @@ -153 +164 @@ Using the AWS Management Console, you can create outbound external links in your - 3. Select an RTB application from the list. + 3. Select a gateway from the list. @@ -155 +166 @@ Using the AWS Management Console, you can create outbound external links in your - 4. On the application details page, choose the **Associated links** tab. + 4. On the gateway details page, choose the **Associated links** tab. @@ -194,9 +205 @@ Using the AWS Management Console, you can create outbound external links in your -Once the link status changes to **Active** , it begins facilitating communication between your RTB application and the external target endpoint. You can monitor link performance and make configuration changes as needed. - -External links enable connectivity between your RTB Fabric gateways and external partners over the public internet, extending your RTB infrastructure beyond private VPC connections. This feature supports integration with external supply-side platforms (SSPs), demand-side platforms (DSPs), and other RTB partners who are not using RTB Fabric infrastructure. - -External links differ from standard RTB Fabric links in several key ways: - - * **Public internet connectivity** – Traffic flows over the public internet rather than private AWS network infrastructure. - - * **Client IP preservation** – In inbound external links, the original client IP addresses are preserved, enabling DSPs to implement IP-based filtering and geographic targeting. +Once the link status changes to **Active** , it begins facilitating communication between your gateway and the external target endpoint. You can monitor link performance and make configuration changes as needed. @@ -204 +207 @@ External links differ from standard RTB Fabric links in several key ways: - * **Opt-in feature** – External link capability must be explicitly enabled for your account. Contact AWS support to request access to external link functionality. +Use the following command to create an outbound external link using the AWS Command Line Interface (AWS CLI). @@ -206 +209 @@ External links differ from standard RTB Fabric links in several key ways: - * **API-only creation** – External links can only be created and managed through the RTB Fabric API, not through the console. +**Create an outbound external link** @@ -208,0 +212,7 @@ External links differ from standard RTB Fabric links in several key ways: + $ aws rtbfabric create-outbound-external-link \ + --gateway-id rtb-gw-source123 \ + --log-settings '{"applicationLogs":{"sampling":{"errorLog":100.0,"filterLog":0}}}' \ + --public-endpoint http://example.com \ + --tags '{"Name": "Team RTB Outbound External Link"}' \ + --endpoint-url https://rtbfabric.us-east-1.amazonaws.com \ + --region us-east-1 @@ -209,0 +220 @@ External links differ from standard RTB Fabric links in several key ways: +#### Response @@ -211 +222 @@ External links differ from standard RTB Fabric links in several key ways: -Use inbound external links to receive traffic from external partners, and outbound external links to send traffic to external endpoints. You can only create external links using the RTB Fabric API. For more information, see [CreateInboundExternalLink](https://docs.aws.amazon.com/rtb-fabric/latest/api/API_CreateInboundExternalLink.html) and [CreateOutboundExternalLink](https://docs.aws.amazon.com/rtb-fabric/latest/api/API_CreateOutboundExternalLink.html) in the _RTB Fabric API Reference_. +The following example shows the response from creating an outbound external link: @@ -213 +223,0 @@ Use inbound external links to receive traffic from external partners, and outbou -### Creating inbound external links @@ -215 +225,5 @@ Use inbound external links to receive traffic from external partners, and outbou -Inbound external links allow external partners to send traffic to your responder gateway over the public internet. When you create an inbound external link, RTB Fabric provides a public domain name that external partners can use to reach your gateway. The following examples show how to create an inbound external link using the RTB Fabric API. For complete specifications, see [CreateInboundExternalLink](https://docs.aws.amazon.com/rtb-fabric/latest/api/API_CreateInboundExternalLink.html) in the _RTB Fabric API Reference_. + { + "gatewayId": "rtb-gw-source123", + "linkId": "link-uvw123", + "status": "Active" + } @@ -217 +231 @@ Inbound external links allow external partners to send traffic to your responder -#### API request +Once created, your requester gateway can send traffic to the specified `publicEndpoint` through the RTB Fabric infrastructure. @@ -219 +233 @@ Inbound external links allow external partners to send traffic to your responder -The following example shows the API request to create an inbound external link: +###### Important @@ -220,0 +235 @@ The following example shows the API request to create an inbound external link: +External links leverage the AWS Global Network where possible but may require public internet routing to reach certain endpoints. This can result in different security, performance, and cost characteristics compared to standard RTB Fabric links. @@ -222 +237 @@ The following example shows the API request to create an inbound external link: - POST /responder-gateway/{gatewayId}/inbound-external-link +### Creating inbound external links @@ -224,5 +239 @@ The following example shows the API request to create an inbound external link: - { - "attributes": { - "customerProvidedId": "external-partner-link-001" - } - } +Inbound external links allow external partners (e.g., SSPs) to send traffic to your responder gateway over the public internet. When you create an inbound external link, RTB Fabric provides a public domain name that external partners can use to reach your gateway. Creating inbound external links is supported through the RTB Fabric API, the AWS CLI, and AWS CloudFormation. The following examples show how to create an inbound external link using the RTB Fabric API. For complete specifications, see [CreateInboundExternalLink](https://docs.aws.amazon.com/rtb-fabric/latest/api/API_CreateInboundExternalLink.html) in the _RTB Fabric API Reference_. @@ -230 +241 @@ The following example shows the API request to create an inbound external link: -#### Example using curl +Use the following command to create an inbound external link using the AWS Command Line Interface (AWS CLI). @@ -232 +243 @@ The following example shows the API request to create an inbound external link: -The following example shows how to create an inbound external link using curl: +**Create an inbound external link** @@ -235,9 +246,6 @@ The following example shows how to create an inbound external link using curl: - curl -X POST \ - "https://rtbfabric.us-east-1.amazonaws.com/responder-gateway/rtb-gw-abc123/inbound-external-link" \ - -H "Authorization: AWS4-HMAC-SHA256 ..." \ - -H "Content-Type: application/json" \ - -d '{ - "attributes": { - "customerProvidedId": "external-partner-link-001" - } - }' + $ aws rtbfabric create-inbound-external-link \ + --gateway-id rtb-gw-target123 \ + --log-settings '{"applicationLogs":{"sampling":{"errorLog":100.0,"filterLog":0}}}' \ + --tags '{"Name": "Team Inbound External Link"}' \ + --endpoint-url https://rtbfabric.us-east-1.amazonaws.com \ + --region us-east-1 @@ -251 +259 @@ The following example shows the response from creating an inbound external link: - "gatewayId": "rtb-gw-abc123", + "gatewayId": "rtb-gw-target123", @@ -254 +262 @@ The following example shows the response from creating an inbound external link: - "domainName": "abc123.rtbfabric.amazonaws.com"