AWS rtb-fabric documentation change
Summary
Restructured documentation by replacing detailed content with links to dedicated pages for each topic, including creating links, external links, testing, editing, accepting/deleting links, adding modules, and configuring logging.
Security assessment
This is purely a documentation restructuring change. The diff shows removal of detailed instructions and replacement with topic links. There is no evidence of security vulnerability fixes, security incident response, or new security features being documented. The removed content included standard operational guidance without security-specific changes.
Diff
diff --git a/rtb-fabric/latest/userguide/links.md b/rtb-fabric/latest/userguide/links.md index ccd7a3c61..5a3df37ba 100644 --- a//rtb-fabric/latest/userguide/links.md +++ b//rtb-fabric/latest/userguide/links.md @@ -7,2 +6,0 @@ -Creating links between RTB Fabric usersTesting and using linksCreating external linksEditing linksAccepting or declining a link requestDeleting linksAdding modules to linksConfiguring link logging - @@ -19,383 +17 @@ To create links with other RTB Fabric users, you must first obtain their gateway - * Creating links between RTB Fabric users - - * Testing and using links - - * Creating external links - - * Editing links - - * Accepting or declining a link request - - * Deleting links - - * Adding modules to links - - * Configuring link logging - - - - -## Creating links between RTB Fabric users - -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. - -###### To create a link between gateways - - 1. Sign in to the AWS Management Console and open the RTB Fabric console at [https://console.aws.amazon.com/rtbfabric/](https://console.aws.amazon.com/rtbfabric/). - - 2. In the navigation pane, choose **Requester gateways**. - - 3. Select a gateway from the list. - - 4. On the gateway details page, choose the **Associated links** tab. - - 5. Choose **Create link**. - - 6. On the **Create link** screen, review the **Gateway details** section, which displays information about the source gateway for this link: - - * **Gateway ID** – The unique identifier of the source gateway. - - * **Gateway name** – The name of the source gateway. - - * **Gateway created on** – The date and time when the gateway was created. - - 7. (Optional) In the **Link information** section, enter a **Correlation ID**. This is a unique identifier you can assign to your link for your own tracking purposes and is not visible to other RTB Fabric users. The correlation ID can have up to 64 characters. - - 8. In the **Application logs configuration** section, configure the sampling rates to capture exceptions, failures, and unexpected system behaviors: - - 1. For **Error logs sampling rate** , enter the percentage (0.0-100.0) of error logs to deliver to your destination. These logs capture exceptions, failures, and unexpected system behaviors. Higher percentages incur additional storage costs. - - 2. For **Filter logs sampling rate** , enter the percentage (0.0-100.0) of filter logs to deliver to your destination. These logs are generated from your other RTB Fabric filter modules. Higher percentages incur additional storage costs. - -Note the following: - - * Logs are delivered via Amazon CloudWatch Vended Logs, which provides delivery directly to Amazon S3, Amazon Data Firehose, or Amazon CloudWatch Logs. - - * To configure log delivery destinations, you must use the RTB Fabric API. For more information, see the [AWS RTB Fabric API Reference](https://docs.aws.amazon.com//rtb-fabric/latest/api/). - - * 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`). - -###### Note - -Contact your RTB Fabric partner to obtain their gateway ID. AWS does not provide gateway IDs. - - 10. Choose **Create link** to send the link request. - - 11. The link is created with a **Requested** status and sent to the target gateway for approval. The target gateway owner must accept the link request before it becomes active. - -###### Important - -Links that are not accepted within 7 days of requesting will time out, and will need to be re-initiated. - - - - -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. - -Use the following command to create a link between gateways using the AWS Command Line Interface (AWS CLI). - -**Create a basic link between gateways** - - - $ aws rtbfabric create-link \ - --gateway-id rtb-gw-source123 \ - --peer-gateway-id rtb-gw-target456 \ - --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** - - - $ aws rtbfabric create-link \ - --gateway-id rtb-gw-source123 \ - --peer-gateway-id rtb-gw-target456 \ - --attributes customerProvidedId=my-link-correlation-123 \ - --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 - -## Testing and using links - -###### Note - -Link addresses will only be visible and accessible from within your VPC. - -###### To test your newly created link - - 1. The URL components in the example below will come from your API responses. If you don't have them at hand, your Gateway ID and Link ID can be found via the AWS Management Console, or by invoking the ListGateways and ListLinks operations outlined in [RTB Fabric API Reference](https://docs.aws.amazon.com/rtb-fabric/latest/api/welcome.html) - - 2. From the command line, use `curl` to send a POST request to the Link. Supply an OpenRTB payload to validate full end-to-end requests to your partner, or an empty body to simply test connectivity. See below for a `curl` example in the us-east-1 region. - - curl -X POST -H "Content-Type: application/json" -d {Your RTB JSON Payload} \ - "https://{your-gateway-id}.{your-aws-account}.gateway.rtbfabric.{your-region}.amazonaws.com/link/{your-link-id}" - -Any additional URL or path params that your partner expects can be appended to the Link URI. - - - - -## Creating external links - -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. - -###### To create an outbound external link - - 1. Sign in to the AWS Management Console and open the RTB Fabric console at [https://console.aws.amazon.com/rtbfabric/](https://console.aws.amazon.com/rtbfabric/). - - 2. In the navigation pane, choose **Requester gateways**. - - 3. Select a gateway from the list. - - 4. On the gateway details page, choose the **Associated links** tab. - - 5. Choose **Create link**. - - 6. On the **Create link** screen, review the **Requester Gateway details** section, which displays information about the source gateway for this external outbound link: - - * **Gateway ID** – The unique identifier of the source gateway. - - * **Gateway name** – The name of the source gateway. - - * **Gateway created on** – The date and time when the gateway was created. - - 7. Choose **Outbound external link** in the **Link settings**. - - 8. In the **Target details** section, enter the **Target endpoint** of the target responder you want to link with. Enter a valid HTTPS or HTTP public endpoint that accepts RTB requests (for example: `https://example.com`). - - 9. (Optional) In the **Link information** section, enter a **Correlation ID**. This is a unique identifier you can assign to your link for your own tracking purposes and is not visible to other RTB Fabric users. The correlation ID can have up to 64 characters. - - 10. In the **Application logs configuration** section, configure the sampling rates to capture exceptions, failures, and unexpected system behaviors: - - 1. For **Error logs sampling rate** , enter the percentage (0.0-100.0) of error logs to deliver to your destination. These logs capture exceptions, failures, and unexpected system behaviors. Higher percentages incur additional storage costs. - - 2. For **Filter logs sampling rate** , enter the percentage (0.0-100.0) of filter logs to deliver to your destination. These logs are generated from your other RTB Fabric filter modules. Higher percentages incur additional storage costs. - - 3. Note the following: - - 1. Logs are delivered via [Amazon CloudWatch Vended Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html), which provides delivery directly to Amazon S3, Amazon Data Firehose, or Amazon CloudWatch Logs. - - 2. To configure log delivery destinations, you must use the RTB Fabric API. For more information, see the [AWS RTB Fabric API Reference](https://docs.aws.amazon.com//rtb-fabric/latest/api/). - - 3. AWS does not access or read your log data. - - 11. Choose **Create link** to send the link request. - - 12. The link starts in **Pending Creation** status and becomes **Active** within 3 minutes. - - - -