:doc:`RDS <../../rds>` / Client / modify_db_proxy_endpoint

************************
modify_db_proxy_endpoint
************************



.. py:method:: RDS.Client.modify_db_proxy_endpoint(**kwargs)

  

  Changes the settings for an existing DB proxy endpoint.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBProxyEndpoint>`_  


  **Request Syntax**
  ::

    response = client.modify_db_proxy_endpoint(
        DBProxyEndpointName='string',
        NewDBProxyEndpointName='string',
        VpcSecurityGroupIds=[
            'string',
        ]
    )
    
  :type DBProxyEndpointName: string
  :param DBProxyEndpointName: **[REQUIRED]** 

    The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

    

  
  :type NewDBProxyEndpointName: string
  :param NewDBProxyEndpointName: 

    The new identifier for the ``DBProxyEndpoint``. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    

  
  :type VpcSecurityGroupIds: list
  :param VpcSecurityGroupIds: 

    The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'DBProxyEndpoint': {
              'DBProxyEndpointName': 'string',
              'DBProxyEndpointArn': 'string',
              'DBProxyName': 'string',
              'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
              'VpcId': 'string',
              'VpcSecurityGroupIds': [
                  'string',
              ],
              'VpcSubnetIds': [
                  'string',
              ],
              'Endpoint': 'string',
              'CreatedDate': datetime(2015, 1, 1),
              'TargetRole': 'READ_WRITE'|'READ_ONLY',
              'IsDefault': True|False,
              'EndpointNetworkType': 'IPV4'|'IPV6'|'DUAL'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DBProxyEndpoint** *(dict) --* 

        The ``DBProxyEndpoint`` object representing the new settings for the DB proxy endpoint.

        
        

        - **DBProxyEndpointName** *(string) --* 

          The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

          
        

        - **DBProxyEndpointArn** *(string) --* 

          The Amazon Resource Name (ARN) for the DB proxy endpoint.

          
        

        - **DBProxyName** *(string) --* 

          The identifier for the DB proxy that is associated with this DB proxy endpoint.

          
        

        - **Status** *(string) --* 

          The current status of this DB proxy endpoint. A status of ``available`` means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

          
        

        - **VpcId** *(string) --* 

          Provides the VPC ID of the DB proxy endpoint.

          
        

        - **VpcSecurityGroupIds** *(list) --* 

          Provides a list of VPC security groups that the DB proxy endpoint belongs to.

          
          

          - *(string) --* 
      
        

        - **VpcSubnetIds** *(list) --* 

          The EC2 subnet IDs for the DB proxy endpoint.

          
          

          - *(string) --* 
      
        

        - **Endpoint** *(string) --* 

          The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

          
        

        - **CreatedDate** *(datetime) --* 

          The date and time when the DB proxy endpoint was first created.

          
        

        - **TargetRole** *(string) --* 

          A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

          
        

        - **IsDefault** *(boolean) --* 

          Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

          
        

        - **EndpointNetworkType** *(string) --* 

          The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

           

          Valid values:

           

          
          * ``IPV4`` - The proxy endpoint supports IPv4 only.
           
          * ``IPV6`` - The proxy endpoint supports IPv6 only.
           
          * ``DUAL`` - The proxy endpoint supports both IPv4 and IPv6.
          

          
    
  
  **Exceptions**
  
  *   :py:class:`RDS.Client.exceptions.InvalidDBProxyEndpointStateFault`

  
  *   :py:class:`RDS.Client.exceptions.DBProxyEndpointAlreadyExistsFault`

  
  *   :py:class:`RDS.Client.exceptions.DBProxyEndpointNotFoundFault`

  
  *   :py:class:`RDS.Client.exceptions.InvalidDBProxyStateFault`

  