Skip to content

create_transit_gateway_route async

create_transit_gateway_route(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = 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,
) -> CreateTransitGatewayRouteResult

Creates a static route for the specified transit gateway route table.

Parameters:

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

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

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

    The ID of the transit gateway route table.

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

    The ID of the attachment.

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

    Indicates whether to drop traffic that matches this route.

  • 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/async_ec2.py
async def create_transit_gateway_route(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = 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.create_transit_gateway_route_result.CreateTransitGatewayRouteResult":
    """<p>Creates a static route for the specified transit gateway route table.</p>

    Args:
        destination_cidr_block: <p>The CIDR range used for destination matches. Routing decisions are based on the most specific match.</p>
        transit_gateway_route_table_id: <p>The ID of the transit gateway route table.</p>
        transit_gateway_attachment_id: <p>The ID of the attachment.</p>
        blackhole: <p>Indicates whether to drop traffic that matches this route.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.create_transit_gateway_route_request.CreateTransitGatewayRouteRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.create_transit_gateway_route_result.CreateTransitGatewayRouteResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_transit_gateway_route

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.create_transit_gateway_route.async_create_transit_gateway_route(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateTransitGatewayRoute")
    )
    input_: capo_ec2.types.create_transit_gateway_route_request.CreateTransitGatewayRouteRequest = {}
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output