EnableRouteServerPropagationCommand

Suggest an Edit

Defines which route tables the route server can update with routes.

When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.

For more information see Dynamic routing in your VPC with VPC Route Server  in the Amazon VPC User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, EnableRouteServerPropagationCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, EnableRouteServerPropagationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // EnableRouteServerPropagationRequest
  RouteServerId: "STRING_VALUE", // required
  RouteTableId: "STRING_VALUE", // required
  DryRun: true || false,
};
const command = new EnableRouteServerPropagationCommand(input);
const response = await client.send(command);
// { // EnableRouteServerPropagationResult
//   RouteServerPropagation: { // RouteServerPropagation
//     RouteServerId: "STRING_VALUE",
//     RouteTableId: "STRING_VALUE",
//     State: "pending" || "available" || "deleting",
//   },
// };

EnableRouteServerPropagationCommand Input

See EnableRouteServerPropagationCommandInput for more details

Parameter
Type
Description
RouteServerId
Required
string | undefined

The ID of the route server for which to enable propagation.

RouteTableId
Required
string | undefined

The ID of the route table to which route server will propagate routes.

DryRun
boolean | undefined

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

EnableRouteServerPropagationCommand Output

See EnableRouteServerPropagationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RouteServerPropagation
RouteServerPropagation | undefined

Information about the enabled route server propagation.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.