Skip to content

disable_transit_gateway_route_table_propagation

disable_transit_gateway_route_table_propagation(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[TransitGatewayRouteTableId] = None,
    transit_gateway_attachment_id: Optional[TransitGatewayAttachmentId] = None,
    dry_run: Optional[Boolean] = None,
    transit_gateway_route_table_announcement_id: Optional[
        TransitGatewayRouteTableAnnouncementId
    ] = None,
) -> DisableTransitGatewayRouteTablePropagationResult

Disables the specified resource attachment from propagating routes to the specified propagation route table.

Parameters:

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

    The ID of the propagation route table.

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

    The ID of the attachment.

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

  • transit_gateway_route_table_announcement_id (Optional[TransitGatewayRouteTableAnnouncementId], default: None ) –

    The ID of the route table announcement.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def disable_transit_gateway_route_table_propagation(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = 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,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    transit_gateway_route_table_announcement_id: Optional[
        "capo_ec2.types.transit_gateway_route_table_announcement_id.TransitGatewayRouteTableAnnouncementId"
    ] = None,
) -> "capo_ec2.types.disable_transit_gateway_route_table_propagation_result.DisableTransitGatewayRouteTablePropagationResult":
    """<p>Disables the specified resource attachment from propagating routes to the specified propagation route table.</p>

    Args:
        transit_gateway_route_table_id: <p>The ID of the propagation route table.</p>
        transit_gateway_attachment_id: <p>The ID of the attachment.</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>
        transit_gateway_route_table_announcement_id: <p>The ID of the route table announcement.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.disable_transit_gateway_route_table_propagation_request.DisableTransitGatewayRouteTablePropagationRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.disable_transit_gateway_route_table_propagation_result.DisableTransitGatewayRouteTablePropagationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.disable_transit_gateway_route_table_propagation

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DisableTransitGatewayRouteTablePropagation"),
    )
    input_: capo_ec2.types.disable_transit_gateway_route_table_propagation_request.DisableTransitGatewayRouteTablePropagationRequest = {}
    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 dry_run is not None:
        input_["dry_run"] = dry_run
    if transit_gateway_route_table_announcement_id is not None:
        input_["transit_gateway_route_table_announcement_id"] = (
            transit_gateway_route_table_announcement_id
        )

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