Updated on 2023-12-26 GMT+08:00

Connections

You can use the default connection for a public webhook, or a custom one (with specified VPC and subnet) for a private webhook.

Custom connections can also be based on DMS for Kafka.

  • A client or proxy client provides a webhook URL to receive data from a specified server. The client updates accordingly once the server pushes data to the URL.
  • Webhook URLs must support TLS 1.2 and secure encryption algorithms.

Creating a Webhook Connection

Before creating a connection, ensure that you have VPC permissions.

  1. Log in to the EG console.
  2. In the navigation pane, choose Network Management > Connections.
  3. Click Create Connection.

    When you create your first connection, your authorization will be required and an agency will be automatically created. For details, see Authorization.

  4. Configure the connection by referring to Table 1.

    Table 1 Connection parameters

    Parameter

    Description

    Type

    Select WEBHOOK.

    Name

    Connection name.

    The name cannot be modified once the connection is created.

    Description

    Describe the connection.

    VPC

    Select a VPC.

    The VPC cannot be changed once the connection is created.

    Subnet

    Select a subnet.

    The subnet cannot be changed once the connection is created.

  5. Click OK.

Creating a DMS for Kafka Connection

Before creating such a connection, ensure that you already have a DMS for Kafka instance.

  1. Log in to the EG console.
  2. In the navigation pane, choose Network Management > Connections.
  3. Click Create Connection.

    When you create your first connection, your authorization will be required and an agency will be automatically created. For details, see Authorization.

    Kafka instance parameters cannot be modified once the connection is created.

  4. Configure the connection by referring to Table 2.

    Table 2 Kafka connection parameters

    Parameter

    Description

    Type

    Select DMS for Kafka.

    Name

    Connection name.

    The name cannot be modified once the connection is created.

    Description

    Describe the connection.

    Instance

    Select a Kafka instance.

    Access Mode

    Select Ciphertext Access or Plaintext Access.

    Security Protocol

    If you select Ciphertext Access for Access Mode, the corresponding security protocol will be displayed.

    SASL_SSL Authentication

    Available when SASL_SSL authentication is enabled for the Kafka instance. Select an authentication mechanism.

    • PLAIN: a simple username and password verification mechanism.
    • SCRAM-SHA-512: uses the hash algorithm to generate credentials for usernames and passwords to verify identities. SCRAM-SHA-512 is more secure than PLAIN.

    Username

    Available when SASL_SSL authentication is enabled for the Kafka instance. Enter a username.

    Password

    Available when SASL_SSL authentication is enabled for the Kafka instance. Enter a password.

    Acknowledgments

    Number of acknowledgments the producer requires the server to return before considering a request complete.

    • None: The producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record.
    • Leader only: The leader will write the record to its local log but will respond without waiting until receiving full acknowledgement from all followers. If the leader fails immediately after acknowledging the record but before the followers have replicated it, the record will be lost.
    • All: The leader will wait for the full set of in-sync replicas to acknowledge the record. This is the strongest available guarantee because the record will not be lost as long as there is just one working replica.

  5. Click OK.

Editing a Connection

Only the description of a connection can be modified.

  1. Log in to the EG console.
  2. In the navigation pane, choose Network Management > Connections.
  3. Click Edit in the row that contains the desired connection.
  4. Modify the description and click OK.

Deleting a Connection

  1. Log in to the EG console.
  2. In the navigation pane, choose Network Management > Connections.
  3. Click Delete in the row that contains the desired connection.

    If the connection to delete is associated with subscriptions, disassociate it first.

  4. Click Yes.