@aws-sdk/client-servicediscovery

What is @aws-sdk/client-servicediscovery?

@aws-sdk/client-servicediscovery is a part of the AWS SDK for JavaScript, which allows developers to interact with AWS Cloud Map. AWS Cloud Map is a cloud resource discovery service that lets you define custom names for your application resources, and it maintains the updated location of these dynamically changing resources.

What are @aws-sdk/client-servicediscovery's main functionalities?

Create Service

This feature allows you to create a new service within a specified namespace. The code sample demonstrates how to create a service with DNS configuration.

const { ServiceDiscoveryClient, CreateServiceCommand } = require('@aws-sdk/client-servicediscovery');

const client = new ServiceDiscoveryClient({ region: 'us-west-2' });
const command = new CreateServiceCommand({
  Name: 'my-service',
  NamespaceId: 'ns-12345678',
  DnsConfig: {
    NamespaceId: 'ns-12345678',
    RoutingPolicy: 'MULTIVALUE',
    DnsRecords: [
      {
        Type: 'A',
        TTL: 60
      }
    ]
  }
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Register Instance

This feature allows you to register an instance to a service. The code sample demonstrates how to register an instance with specific attributes like IP address and port.

const { ServiceDiscoveryClient, RegisterInstanceCommand } = require('@aws-sdk/client-servicediscovery');

const client = new ServiceDiscoveryClient({ region: 'us-west-2' });
const command = new RegisterInstanceCommand({
  ServiceId: 'srv-12345678',
  InstanceId: 'i-12345678',
  Attributes: {
    AWS_INSTANCE_IPV4: '192.0.2.44',
    AWS_INSTANCE_PORT: '80'
  }
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Discover Instances

This feature allows you to discover registered instances for a given namespace and service. The code sample demonstrates how to discover instances with a maximum result limit.

const { ServiceDiscoveryClient, DiscoverInstancesCommand } = require('@aws-sdk/client-servicediscovery');

const client = new ServiceDiscoveryClient({ region: 'us-west-2' });
const command = new DiscoverInstancesCommand({
  NamespaceName: 'my-namespace',
  ServiceName: 'my-service',
  MaxResults: 10
});

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Other packages similar to @aws-sdk/client-servicediscovery

consul

Consul by HashiCorp is a service networking solution to connect and secure services across any runtime platform and public or private cloud. It provides service discovery, configuration, and segmentation functionality. Compared to @aws-sdk/client-servicediscovery, Consul offers a more comprehensive suite of features for service mesh and network automation.

etcd

etcd is a distributed key-value store that provides a reliable way to store data across a cluster of machines. It is often used for service discovery, distributed configuration management, and leader election. While @aws-sdk/client-servicediscovery is specific to AWS Cloud Map, etcd is a more general-purpose solution that can be used in various environments.

zookeeper

Apache ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. It is widely used in distributed systems for service discovery and configuration management. Compared to @aws-sdk/client-servicediscovery, ZooKeeper is more complex and offers a broader range of distributed coordination capabilities.

README

@aws-sdk/client-servicediscovery

For SDK usage, please step to SDK reademe.