Skip to content

replace_transit_gateway_route

replace_transit_gateway_route(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    destination_cidr_block: Optional[String] = None,
    transit_gateway_route_table_id: Optional[TransitGatewayRouteTableId] = None,
    transit_gateway_attachment_id: Optional[TransitGatewayAttachmentId] = None,
    blackhole: Optional[Boolean] = None,
    dry_run: Optional[Boolean] = None,
) -> ReplaceTransitGatewayRouteResult

Replaces the specified route in the specified transit gateway route table.

Parameters:

  • destination_cidr_block (Optional[String], default: None ) –

    The CIDR range used for the destination match. Routing decisions are based on the most specific match.

  • transit_gateway_route_table_id (Optional[TransitGatewayRouteTableId], default: None ) –

    The ID of the route table.

  • transit_gateway_attachment_id (Optional[TransitGatewayAttachmentId], default: None ) –

    The ID of the attachment.

  • blackhole (Optional[Boolean], default: None ) –

    Indicates whether traffic matching this route is to be dropped.

  • dry_run (Optional[Boolean], default: None ) –

    Checks 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def replace_transit_gateway_route(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    destination_cidr_block: Optional["capo_ec2.types.string.String"] = None,
    transit_gateway_route_table_id: Optional[
        "capo_ec2.types.transit_gateway_route_table_id.TransitGatewayRouteTableId"
    ] = None,
    transit_gateway_attachment_id: Optional[
        "capo_ec2.types.transit_gateway_attachment_id.TransitGatewayAttachmentId"
    ] = None,
    blackhole: Optional["capo_ec2.types.boolean.Boolean"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.replace_transit_gateway_route_result.ReplaceTransitGatewayRouteResult":
    """<p>Replaces the specified route in the specified transit gateway route table.</p>

    Args:
        destination_cidr_block: <p>The CIDR range used for the destination match. Routing decisions are based on the most specific match.</p>
        transit_gateway_route_table_id: <p>The ID of the route table.</p>
        transit_gateway_attachment_id: <p>The ID of the attachment.</p>
        blackhole: <p>Indicates whether traffic matching this route is to be dropped.</p>
        dry_run: <p>Checks 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.replace_transit_gateway_route_request.ReplaceTransitGatewayRouteRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.replace_transit_gateway_route_result.ReplaceTransitGatewayRouteResult"
    ]:
        import capo_ec2._operations.amazon_ec2.replace_transit_gateway_route

        output, http_response = (
            capo_ec2._operations.amazon_ec2.replace_transit_gateway_route.replace_transit_gateway_route(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReplaceTransitGatewayRoute")
    )
    input_: capo_ec2.types.replace_transit_gateway_route_request.ReplaceTransitGatewayRouteRequest = {}
    if destination_cidr_block is not None:
        input_["destination_cidr_block"] = destination_cidr_block
    if transit_gateway_route_table_id is not None:
        input_["transit_gateway_route_table_id"] = transit_gateway_route_table_id
    if transit_gateway_attachment_id is not None:
        input_["transit_gateway_attachment_id"] = transit_gateway_attachment_id
    if blackhole is not None:
        input_["blackhole"] = blackhole
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output