Skip to content

create_coip_pool

create_coip_pool(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    local_gateway_route_table_id: Optional[LocalGatewayRoutetableId] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
    dry_run: Optional[Boolean] = None,
) -> CreateCoipPoolResult

Creates a pool of customer-owned IP (CoIP) addresses.

Parameters:

  • local_gateway_route_table_id (Optional[LocalGatewayRoutetableId], default: None ) –

    The ID of the local gateway route table.

  • tag_specifications (Optional[TagSpecificationList], default: None ) –

    The tags to assign to the CoIP address pool.

  • 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_coip_pool(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    local_gateway_route_table_id: Optional[
        "capo_ec2.types.local_gateway_routetable_id.LocalGatewayRoutetableId"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.create_coip_pool_result.CreateCoipPoolResult":
    """<p> Creates a pool of customer-owned IP (CoIP) addresses. </p>

    Args:
        local_gateway_route_table_id: <p> The ID of the local gateway route table. </p>
        tag_specifications: <p> The tags to assign to the CoIP address pool. </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_coip_pool_request.CreateCoipPoolRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_coip_pool_result.CreateCoipPoolResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_coip_pool

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCoipPool")
    )
    input_: capo_ec2.types.create_coip_pool_request.CreateCoipPoolRequest = {}
    if local_gateway_route_table_id is not None:
        input_["local_gateway_route_table_id"] = local_gateway_route_table_id
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    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