Skip to content

create_transit_gateway_prefix_list_reference

create_transit_gateway_prefix_list_reference(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[TransitGatewayRouteTableId] = None,
    prefix_list_id: Optional[PrefixListResourceId] = None,
    transit_gateway_attachment_id: Optional[TransitGatewayAttachmentId] = None,
    blackhole: Optional[Boolean] = None,
    dry_run: Optional[Boolean] = None,
) -> CreateTransitGatewayPrefixListReferenceResult

Creates a reference (route) to a prefix list in a specified transit gateway route table.

Parameters:

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

    The ID of the transit gateway route table.

  • prefix_list_id (Optional[PrefixListResourceId], default: None ) –

    The ID of the prefix list that is used for destination matches.

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

    The ID of the attachment to which traffic is routed.

  • 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/ec2.py
def create_transit_gateway_prefix_list_reference(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[
        "capo_ec2.types.transit_gateway_route_table_id.TransitGatewayRouteTableId"
    ] = None,
    prefix_list_id: Optional[
        "capo_ec2.types.prefix_list_resource_id.PrefixListResourceId"
    ] = 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_prefix_list_reference_result.CreateTransitGatewayPrefixListReferenceResult":
    """<p>Creates a reference (route) to a prefix list in a specified transit gateway route table.</p>

    Args:
        transit_gateway_route_table_id: <p>The ID of the transit gateway route table.</p>
        prefix_list_id: <p>The ID of the prefix list that is used for destination matches.</p>
        transit_gateway_attachment_id: <p>The ID of the attachment to which traffic is routed.</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.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_transit_gateway_prefix_list_reference_request.CreateTransitGatewayPrefixListReferenceRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_transit_gateway_prefix_list_reference_result.CreateTransitGatewayPrefixListReferenceResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_transit_gateway_prefix_list_reference

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateTransitGatewayPrefixListReference"),
    )
    input_: capo_ec2.types.create_transit_gateway_prefix_list_reference_request.CreateTransitGatewayPrefixListReferenceRequest = {}
    if transit_gateway_route_table_id is not None:
        input_["transit_gateway_route_table_id"] = transit_gateway_route_table_id
    if prefix_list_id is not None:
        input_["prefix_list_id"] = prefix_list_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