@datafire/amazonaws_servicediscovery

5.0.0 • Public • Published

@datafire/amazonaws_servicediscovery

Client library for Amazon Route 53 Auto Naming

Installation and Usage

npm install --save @datafire/amazonaws_servicediscovery
let amazonaws_servicediscovery = require('@datafire/amazonaws_servicediscovery').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_servicediscovery.CreatePrivateDnsNamespace({
  "Name": "",
  "Vpc": ""
}).then(data => {
  console.log(data);
});

Description

Amazon Route 53 auto naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the auto naming API to register the instance, and Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records.

Actions

CreatePrivateDnsNamespace

amazonaws_servicediscovery.CreatePrivateDnsNamespace({
  "Name": "",
  "Vpc": ""
}, context)

Input

Output

CreatePublicDnsNamespace

amazonaws_servicediscovery.CreatePublicDnsNamespace({
  "Name": ""
}, context)

Input

Output

CreateService

amazonaws_servicediscovery.CreateService({
  "Name": "",
  "DnsConfig": {
    "NamespaceId": "",
    "DnsRecords": []
  }
}, context)

Input

Output

DeleteNamespace

amazonaws_servicediscovery.DeleteNamespace({
  "Id": ""
}, context)

Input

Output

DeleteService

amazonaws_servicediscovery.DeleteService({
  "Id": ""
}, context)

Input

Output

DeregisterInstance

amazonaws_servicediscovery.DeregisterInstance({
  "ServiceId": "",
  "InstanceId": ""
}, context)

Input

Output

GetInstance

amazonaws_servicediscovery.GetInstance({
  "ServiceId": "",
  "InstanceId": ""
}, context)

Input

Output

GetInstancesHealthStatus

amazonaws_servicediscovery.GetInstancesHealthStatus({
  "ServiceId": ""
}, context)

Input

Output

GetNamespace

amazonaws_servicediscovery.GetNamespace({
  "Id": ""
}, context)

Input

Output

GetOperation

amazonaws_servicediscovery.GetOperation({
  "OperationId": ""
}, context)

Input

Output

GetService

amazonaws_servicediscovery.GetService({
  "Id": ""
}, context)

Input

Output

ListInstances

amazonaws_servicediscovery.ListInstances({
  "ServiceId": ""
}, context)

Input

Output

ListNamespaces

amazonaws_servicediscovery.ListNamespaces({}, context)

Input

Output

ListOperations

amazonaws_servicediscovery.ListOperations({}, context)

Input

Output

ListServices

amazonaws_servicediscovery.ListServices({}, context)

Input

Output

RegisterInstance

amazonaws_servicediscovery.RegisterInstance({
  "ServiceId": "",
  "InstanceId": "",
  "Attributes": []
}, context)

Input

Output

UpdateService

amazonaws_servicediscovery.UpdateService({
  "Id": "",
  "Service": {
    "DnsConfig": {
      "DnsRecords": []
    }
  }
}, context)

Input

Output

Definitions

Arn

  • Arn string

AttrKey

  • AttrKey string

AttrValue

  • AttrValue string

Attributes

Code

  • Code string

CreatePrivateDnsNamespaceRequest

CreatePrivateDnsNamespaceResponse

  • CreatePrivateDnsNamespaceResponse object

CreatePublicDnsNamespaceRequest

CreatePublicDnsNamespaceResponse

  • CreatePublicDnsNamespaceResponse object

CreateServiceRequest

CreateServiceResponse

  • CreateServiceResponse object

DeleteNamespaceRequest

  • DeleteNamespaceRequest object

DeleteNamespaceResponse

  • DeleteNamespaceResponse object

DeleteServiceRequest

  • DeleteServiceRequest object

DeleteServiceResponse

  • DeleteServiceResponse object

DeregisterInstanceRequest

DeregisterInstanceResponse

  • DeregisterInstanceResponse object

DnsConfig

  • DnsConfig object: A complex type that contains information about the records that you want Amazon Route 53 to create when you register an instance.

DnsConfigChange

  • DnsConfigChange object: A complex type that contains information about changes to the records that Route 53 creates when you register an instance.

DnsProperties

  • DnsProperties object: A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.

DnsRecord

  • DnsRecord object: A complex type that contains information about the records that you want Route 53 to create when you register an instance.

DnsRecordList

DuplicateRequest

  • DuplicateRequest object: The operation is already in progress.

ErrorMessage

  • ErrorMessage string

FailureThreshold

  • FailureThreshold integer

FilterCondition

  • FilterCondition string (values: EQ, IN, BETWEEN)

FilterValue

  • FilterValue string

FilterValues

GetInstanceRequest

GetInstanceResponse

  • GetInstanceResponse object

GetInstancesHealthStatusRequest

GetInstancesHealthStatusResponse

GetNamespaceRequest

  • GetNamespaceRequest object

GetNamespaceResponse

  • GetNamespaceResponse object

GetOperationRequest

  • GetOperationRequest object

GetOperationResponse

  • GetOperationResponse object

GetServiceRequest

GetServiceResponse

  • GetServiceResponse object

HealthCheckConfig

  • HealthCheckConfig object:

    Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in DnsConfig.

    A and AAAA records

    If DnsConfig includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

    CNAME records

    You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

    Request interval

    The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

    Health checking regions

    Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions.

    Alias records

    When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Route 53 creates an alias record. Note the following:

    • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

    • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

    For information about the charges for health checks, see Route 53 Pricing.

HealthCheckType

  • HealthCheckType string (values: HTTP, HTTPS, TCP)

HealthStatus

  • HealthStatus string (values: HEALTHY, UNHEALTHY, UNKNOWN)

Instance

  • Instance object: A complex type that contains information about an instance that Amazon Route 53 creates when you submit a RegisterInstance request.

InstanceHealthStatusMap

InstanceIdList

InstanceNotFound

  • InstanceNotFound object: No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

InstanceSummary

  • InstanceSummary object: A complex type that contains information about the instances that you registered by using a specified service.

InstanceSummaryList

InvalidInput

  • InvalidInput object: One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

ListInstancesRequest

ListInstancesResponse

ListNamespacesRequest

ListNamespacesResponse

ListOperationsRequest

ListOperationsResponse

ListServicesRequest

ListServicesResponse

MaxResults

  • MaxResults integer

Message

  • Message string

Namespace

NamespaceAlreadyExists

  • NamespaceAlreadyExists object: The namespace that you're trying to create already exists.

NamespaceFilter

  • NamespaceFilter object: A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

NamespaceFilterName

  • NamespaceFilterName string (values: TYPE)

NamespaceFilters

NamespaceName

  • NamespaceName string

NamespaceNotFound

  • NamespaceNotFound object: No namespace exists with the specified ID.

NamespaceProperties

  • NamespaceProperties object: A complex type that contains information that is specific to the namespace type.

NamespaceSummariesList

NamespaceSummary

NamespaceType

  • NamespaceType string (values: DNS_PUBLIC, DNS_PRIVATE)

NextToken

  • NextToken string

Operation

OperationFilter

OperationFilterName

  • OperationFilterName string (values: NAMESPACE_ID, SERVICE_ID, STATUS, TYPE, UPDATE_DATE)

OperationFilters

OperationId

  • OperationId string

OperationNotFound

  • OperationNotFound object: No operation exists with the specified ID.

OperationStatus

  • OperationStatus string (values: SUBMITTED, PENDING, SUCCESS, FAIL)

OperationSummary

  • OperationSummary object: A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.

OperationSummaryList

OperationTargetType

  • OperationTargetType string (values: NAMESPACE, SERVICE, INSTANCE)

OperationTargetsMap

OperationType

  • OperationType string (values: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, DEREGISTER_INSTANCE)

RecordTTL

  • RecordTTL integer

RecordType

  • RecordType string (values: SRV, A, AAAA, CNAME)

RegisterInstanceRequest

RegisterInstanceResponse

  • RegisterInstanceResponse object

ResourceCount

  • ResourceCount integer

ResourceDescription

  • ResourceDescription string

ResourceId

  • ResourceId string

ResourceInUse

  • ResourceInUse object: The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.

ResourceLimitExceeded

  • ResourceLimitExceeded object: The resource can't be created because you've reached the limit on the number of resources.

ResourcePath

  • ResourcePath string

RoutingPolicy

  • RoutingPolicy string (values: MULTIVALUE, WEIGHTED)

Service

ServiceAlreadyExists

  • ServiceAlreadyExists object: The service can't be created because a service with the same name already exists.

ServiceChange

ServiceFilter

ServiceFilterName

  • ServiceFilterName string (values: NAMESPACE_ID)

ServiceFilters

ServiceName

  • ServiceName string

ServiceNotFound

  • ServiceNotFound object: No service exists with the specified ID.

ServiceSummariesList

ServiceSummary

Timestamp

  • Timestamp string

UpdateServiceRequest

UpdateServiceResponse

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_servicediscovery

Weekly Downloads

1

Version

5.0.0

License

MIT

Unpacked Size

143 kB

Total Files

4

Last publish

Collaborators

  • datafire