:doc:`EC2 <../../ec2>` / Client / create_client_vpn_route

***********************
create_client_vpn_route
***********************



.. py:method:: EC2.Client.create_client_vpn_route(**kwargs)

  

  Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traﬃc to speciﬁc resources or networks.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateClientVpnRoute>`_  


  **Request Syntax**
  ::

    response = client.create_client_vpn_route(
        ClientVpnEndpointId='string',
        DestinationCidrBlock='string',
        TargetVpcSubnetId='string',
        Description='string',
        ClientToken='string',
        DryRun=True|False
    )
    
  :type ClientVpnEndpointId: string
  :param ClientVpnEndpointId: **[REQUIRED]** 

    The ID of the Client VPN endpoint to which to add the route.

    

  
  :type DestinationCidrBlock: string
  :param DestinationCidrBlock: **[REQUIRED]** 

    The IPv4 address range, in CIDR notation, of the route destination. For example:

     

    
    * To add a route for Internet access, enter ``0.0.0.0/0``
     
    * To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
     
    * To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range
     
    * To add a route for the local network, enter the client CIDR range
    

    

  
  :type TargetVpcSubnetId: string
  :param TargetVpcSubnetId: **[REQUIRED]** 

    The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

     

    Alternatively, if you're adding a route for the local network, specify ``local``.

    

  
  :type Description: string
  :param Description: 

    A brief description of the route.

    

  
  :type ClientToken: string
  :param ClientToken: 

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html>`__.

    This field is autopopulated if not provided.

  
  :type DryRun: boolean
  :param DryRun: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Status': {
              'Code': 'creating'|'active'|'failed'|'deleting',
              'Message': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Status** *(dict) --* 

        The current state of the route.

        
        

        - **Code** *(string) --* 

          The state of the Client VPN endpoint route.

          
        

        - **Message** *(string) --* 

          A message about the status of the Client VPN endpoint route, if applicable.

          
    
  