@datafire/amazonaws_servicediscovery
v5.0.0
Published
DataFire integration for Amazon Route 53 Auto Naming
Downloads
4
Readme
@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
- input
object
- CreatorRequestId ResourceId
- Description ResourceDescription
- Name required NamespaceName
- Vpc required ResourceId
Output
CreatePublicDnsNamespace
amazonaws_servicediscovery.CreatePublicDnsNamespace({
"Name": ""
}, context)
Input
- input
object
- CreatorRequestId ResourceId
- Description ResourceDescription
- Name required NamespaceName
Output
CreateService
amazonaws_servicediscovery.CreateService({
"Name": "",
"DnsConfig": {
"NamespaceId": "",
"DnsRecords": []
}
}, context)
Input
- input
object
- CreatorRequestId ResourceId
- Description ResourceDescription
- DnsConfig required DnsConfig
- HealthCheckConfig HealthCheckConfig
- Name required ServiceName
Output
- output CreateServiceResponse
DeleteNamespace
amazonaws_servicediscovery.DeleteNamespace({
"Id": ""
}, context)
Input
- input
object
- Id required ResourceId
Output
- output DeleteNamespaceResponse
DeleteService
amazonaws_servicediscovery.DeleteService({
"Id": ""
}, context)
Input
- input
object
- Id required ResourceId
Output
- output DeleteServiceResponse
DeregisterInstance
amazonaws_servicediscovery.DeregisterInstance({
"ServiceId": "",
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required ResourceId
- ServiceId required ResourceId
Output
- output DeregisterInstanceResponse
GetInstance
amazonaws_servicediscovery.GetInstance({
"ServiceId": "",
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required ResourceId
- ServiceId required ResourceId
Output
- output GetInstanceResponse
GetInstancesHealthStatus
amazonaws_servicediscovery.GetInstancesHealthStatus({
"ServiceId": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Instances InstanceIdList
- MaxResults MaxResults
- NextToken NextToken
- ServiceId required ResourceId
- MaxResults
Output
GetNamespace
amazonaws_servicediscovery.GetNamespace({
"Id": ""
}, context)
Input
- input
object
- Id required ResourceId
Output
- output GetNamespaceResponse
GetOperation
amazonaws_servicediscovery.GetOperation({
"OperationId": ""
}, context)
Input
- input
object
- OperationId required ResourceId
Output
- output GetOperationResponse
GetService
amazonaws_servicediscovery.GetService({
"Id": ""
}, context)
Input
- input
object
- Id required ResourceId
Output
- output GetServiceResponse
ListInstances
amazonaws_servicediscovery.ListInstances({
"ServiceId": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults MaxResults
- NextToken NextToken
- ServiceId required ResourceId
- MaxResults
Output
- output ListInstancesResponse
ListNamespaces
amazonaws_servicediscovery.ListNamespaces({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters NamespaceFilters
- MaxResults MaxResults
- NextToken NextToken
- MaxResults
Output
- output ListNamespacesResponse
ListOperations
amazonaws_servicediscovery.ListOperations({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters OperationFilters
- MaxResults MaxResults
- NextToken NextToken
- MaxResults
Output
- output ListOperationsResponse
ListServices
amazonaws_servicediscovery.ListServices({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters ServiceFilters
- MaxResults MaxResults
- NextToken NextToken
- MaxResults
Output
- output ListServicesResponse
RegisterInstance
amazonaws_servicediscovery.RegisterInstance({
"ServiceId": "",
"InstanceId": "",
"Attributes": []
}, context)
Input
- input
object
- Attributes required Attributes
- CreatorRequestId ResourceId
- InstanceId required ResourceId
- ServiceId required ResourceId
Output
- output RegisterInstanceResponse
UpdateService
amazonaws_servicediscovery.UpdateService({
"Id": "",
"Service": {
"DnsConfig": {
"DnsRecords": []
}
}
}, context)
Input
- input
object
- Id required ResourceId
- Service required ServiceChange
Output
- output UpdateServiceResponse
Definitions
Arn
- Arn
string
AttrKey
- AttrKey
string
AttrValue
- AttrValue
string
Attributes
Code
- Code
string
CreatePrivateDnsNamespaceRequest
- CreatePrivateDnsNamespaceRequest
object
- CreatorRequestId ResourceId
- Description ResourceDescription
- Name required NamespaceName
- Vpc required ResourceId
CreatePrivateDnsNamespaceResponse
- CreatePrivateDnsNamespaceResponse
object
- OperationId OperationId
CreatePublicDnsNamespaceRequest
- CreatePublicDnsNamespaceRequest
object
- CreatorRequestId ResourceId
- Description ResourceDescription
- Name required NamespaceName
CreatePublicDnsNamespaceResponse
- CreatePublicDnsNamespaceResponse
object
- OperationId OperationId
CreateServiceRequest
- CreateServiceRequest
object
- CreatorRequestId ResourceId
- Description ResourceDescription
- DnsConfig required DnsConfig
- HealthCheckConfig HealthCheckConfig
- Name required ServiceName
CreateServiceResponse
- CreateServiceResponse
object
- Service Service
DeleteNamespaceRequest
- DeleteNamespaceRequest
object
- Id required ResourceId
DeleteNamespaceResponse
- DeleteNamespaceResponse
object
- OperationId OperationId
DeleteServiceRequest
- DeleteServiceRequest
object
- Id required ResourceId
DeleteServiceResponse
- DeleteServiceResponse
object
DeregisterInstanceRequest
- DeregisterInstanceRequest
object
- InstanceId required ResourceId
- ServiceId required ResourceId
DeregisterInstanceResponse
- DeregisterInstanceResponse
object
- OperationId OperationId
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.- DnsRecords required DnsRecordList
- NamespaceId required ResourceId
- RoutingPolicy RoutingPolicy
DnsConfigChange
- DnsConfigChange
object
: A complex type that contains information about changes to the records that Route 53 creates when you register an instance.- DnsRecords required DnsRecordList
DnsProperties
- DnsProperties
object
: A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.- HostedZoneId ResourceId
DnsRecord
- DnsRecord
object
: A complex type that contains information about the records that you want Route 53 to create when you register an instance.- TTL required RecordTTL
- Type required RecordType
DnsRecordList
- DnsRecordList
array
- items DnsRecord
DuplicateRequest
- DuplicateRequest
object
: The operation is already in progress.- Message ErrorMessage
ErrorMessage
- ErrorMessage
string
FailureThreshold
- FailureThreshold
integer
FilterCondition
- FilterCondition
string
(values: EQ, IN, BETWEEN)
FilterValue
- FilterValue
string
FilterValues
- FilterValues
array
- items FilterValue
GetInstanceRequest
- GetInstanceRequest
object
- InstanceId required ResourceId
- ServiceId required ResourceId
GetInstanceResponse
- GetInstanceResponse
object
- Instance Instance
GetInstancesHealthStatusRequest
- GetInstancesHealthStatusRequest
object
- Instances InstanceIdList
- MaxResults MaxResults
- NextToken NextToken
- ServiceId required ResourceId
GetInstancesHealthStatusResponse
- GetInstancesHealthStatusResponse
object
- NextToken NextToken
- Status InstanceHealthStatusMap
GetNamespaceRequest
- GetNamespaceRequest
object
- Id required ResourceId
GetNamespaceResponse
- GetNamespaceResponse
object
- Namespace Namespace
GetOperationRequest
- GetOperationRequest
object
- OperationId required ResourceId
GetOperationResponse
- GetOperationResponse
object
- Operation Operation
GetServiceRequest
- GetServiceRequest
object
- Id required ResourceId
GetServiceResponse
- GetServiceResponse
object
- Service Service
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.- FailureThreshold FailureThreshold
- ResourcePath ResourcePath
- Type required HealthCheckType
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.- Attributes Attributes
- CreatorRequestId ResourceId
- Id required ResourceId
InstanceHealthStatusMap
- InstanceHealthStatusMap
array
- items
object
- key ResourceId
- value HealthStatus
- items
InstanceIdList
- InstanceIdList
array
- items ResourceId
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.- Message ErrorMessage
InstanceSummary
- InstanceSummary
object
: A complex type that contains information about the instances that you registered by using a specified service.- Attributes Attributes
- Id ResourceId
InstanceSummaryList
- InstanceSummaryList
array
- items InstanceSummary
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.- Message ErrorMessage
ListInstancesRequest
- ListInstancesRequest
object
- MaxResults MaxResults
- NextToken NextToken
- ServiceId required ResourceId
ListInstancesResponse
- ListInstancesResponse
object
- Instances InstanceSummaryList
- NextToken NextToken
ListNamespacesRequest
- ListNamespacesRequest
object
- Filters NamespaceFilters
- MaxResults MaxResults
- NextToken NextToken
ListNamespacesResponse
- ListNamespacesResponse
object
- Namespaces NamespaceSummariesList
- NextToken NextToken
ListOperationsRequest
- ListOperationsRequest
object
- Filters OperationFilters
- MaxResults MaxResults
- NextToken NextToken
ListOperationsResponse
- ListOperationsResponse
object
- NextToken NextToken
- Operations OperationSummaryList
ListServicesRequest
- ListServicesRequest
object
- Filters ServiceFilters
- MaxResults MaxResults
- NextToken NextToken
ListServicesResponse
- ListServicesResponse
object
- NextToken NextToken
- Services ServiceSummariesList
MaxResults
- MaxResults
integer
Message
- Message
string
Namespace
- Namespace
object
: A complex type that contains information about a specified namespace.- Arn Arn
- CreateDate Timestamp
- CreatorRequestId ResourceId
- Description ResourceDescription
- Id ResourceId
- Name NamespaceName
- Properties NamespaceProperties
- ServiceCount ResourceCount
- Type NamespaceType
NamespaceAlreadyExists
- NamespaceAlreadyExists
object
: The namespace that you're trying to create already exists.- CreatorRequestId ResourceId
- Message ErrorMessage
- NamespaceId ResourceId
NamespaceFilter
- NamespaceFilter
object
: A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.- Condition FilterCondition
- Name required NamespaceFilterName
- Values required FilterValues
NamespaceFilterName
- NamespaceFilterName
string
(values: TYPE)
NamespaceFilters
- NamespaceFilters
array
- items NamespaceFilter
NamespaceName
- NamespaceName
string
NamespaceNotFound
- NamespaceNotFound
object
: No namespace exists with the specified ID.- Message ErrorMessage
NamespaceProperties
- NamespaceProperties
object
: A complex type that contains information that is specific to the namespace type.- DnsProperties DnsProperties
NamespaceSummariesList
- NamespaceSummariesList
array
- items NamespaceSummary
NamespaceSummary
- NamespaceSummary
object
: A complex type that contains information about a namespace.- Arn Arn
- Id ResourceId
- Name NamespaceName
- Type NamespaceType
NamespaceType
- NamespaceType
string
(values: DNS_PUBLIC, DNS_PRIVATE)
NextToken
- NextToken
string
Operation
- Operation
object
: A complex type that contains information about a specified operation.- CreateDate Timestamp
- ErrorCode Code
- ErrorMessage Message
- Id OperationId
- Status OperationStatus
- Targets OperationTargetsMap
- Type OperationType
- UpdateDate Timestamp
OperationFilter
- OperationFilter
object
: A complex type that lets you select the operations that you want to list.- Condition FilterCondition
- Name required OperationFilterName
- Values required FilterValues
OperationFilterName
- OperationFilterName
string
(values: NAMESPACE_ID, SERVICE_ID, STATUS, TYPE, UPDATE_DATE)
OperationFilters
- OperationFilters
array
- items OperationFilter
OperationId
- OperationId
string
OperationNotFound
- OperationNotFound
object
: No operation exists with the specified ID.- Message ErrorMessage
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.- Id OperationId
- Status OperationStatus
OperationSummaryList
- OperationSummaryList
array
- items OperationSummary
OperationTargetType
- OperationTargetType
string
(values: NAMESPACE, SERVICE, INSTANCE)
OperationTargetsMap
- OperationTargetsMap
array
- items
object
- key OperationTargetType
- value ResourceId
- items
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
- RegisterInstanceRequest
object
- Attributes required Attributes
- CreatorRequestId ResourceId
- InstanceId required ResourceId
- ServiceId required ResourceId
RegisterInstanceResponse
- RegisterInstanceResponse
object
- OperationId OperationId
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.- Message ErrorMessage
ResourceLimitExceeded
- ResourceLimitExceeded
object
: The resource can't be created because you've reached the limit on the number of resources.- Message ErrorMessage
ResourcePath
- ResourcePath
string
RoutingPolicy
- RoutingPolicy
string
(values: MULTIVALUE, WEIGHTED)
Service
- Service
object
: A complex type that contains information about the specified service.- Arn Arn
- CreateDate Timestamp
- CreatorRequestId ResourceId
- Description ResourceDescription
- DnsConfig DnsConfig
- HealthCheckConfig HealthCheckConfig
- Id ResourceId
- InstanceCount ResourceCount
- Name ServiceName
ServiceAlreadyExists
- ServiceAlreadyExists
object
: The service can't be created because a service with the same name already exists.- CreatorRequestId ResourceId
- Message ErrorMessage
- ServiceId ResourceId
ServiceChange
- ServiceChange
object
: A complex type that contains changes to an existing service.- Description ResourceDescription
- DnsConfig required DnsConfigChange
- HealthCheckConfig HealthCheckConfig
ServiceFilter
- ServiceFilter
object
: A complex type that lets you specify the namespaces that you want to list services for.- Condition FilterCondition
- Name required ServiceFilterName
- Values required FilterValues
ServiceFilterName
- ServiceFilterName
string
(values: NAMESPACE_ID)
ServiceFilters
- ServiceFilters
array
- items ServiceFilter
ServiceName
- ServiceName
string
ServiceNotFound
- ServiceNotFound
object
: No service exists with the specified ID.- Message ErrorMessage
ServiceSummariesList
- ServiceSummariesList
array
- items ServiceSummary
ServiceSummary
- ServiceSummary
object
: A complex type that contains information about a specified service.- Arn Arn
- Description ResourceDescription
- Id ResourceId
- InstanceCount ResourceCount
- Name ServiceName
Timestamp
- Timestamp
string
UpdateServiceRequest
- UpdateServiceRequest
object
- Id required ResourceId
- Service required ServiceChange
UpdateServiceResponse
- UpdateServiceResponse
object
- OperationId OperationId