Class: Aws::ServiceDiscovery::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ServiceDiscovery::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb
Overview
An API client for ServiceDiscovery. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ServiceDiscovery::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_http_namespace(params = {}) ⇒ Types::CreateHttpNamespaceResponse
Creates an HTTP namespace.
-
#create_private_dns_namespace(params = {}) ⇒ Types::CreatePrivateDnsNamespaceResponse
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.
-
#create_public_dns_namespace(params = {}) ⇒ Types::CreatePublicDnsNamespaceResponse
Creates a public namespace based on DNS, which is visible on the internet.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates a service.
-
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes a namespace from the current account.
-
#delete_service(params = {}) ⇒ Struct
Deletes a specified service.
-
#deregister_instance(params = {}) ⇒ Types::DeregisterInstanceResponse
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
-
#discover_instances(params = {}) ⇒ Types::DiscoverInstancesResponse
Discovers registered instances for a specified namespace and service.
-
#get_instance(params = {}) ⇒ Types::GetInstanceResponse
Gets information about a specified instance.
-
#get_instances_health_status(params = {}) ⇒ Types::GetInstancesHealthStatusResponse
Gets the current health status (
Healthy
,Unhealthy
, orUnknown
) of one or more instances that are associated with a specified service. -
#get_namespace(params = {}) ⇒ Types::GetNamespaceResponse
Gets information about a namespace.
-
#get_operation(params = {}) ⇒ Types::GetOperationResponse
Gets information about any operation that returns an operation ID in the response, such as a
CreateService
request. -
#get_service(params = {}) ⇒ Types::GetServiceResponse
Gets the settings for a specified service.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
Lists summary information about the instances that you registered by using a specified service.
-
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists summary information about the namespaces that were created by the current account.
-
#list_operations(params = {}) ⇒ Types::ListOperationsResponse
Lists operations that match the criteria that you specify.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists summary information for all the services that are associated with one or more specified namespaces.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for the specified resource.
-
#register_instance(params = {}) ⇒ Types::RegisterInstanceResponse
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_http_namespace(params = {}) ⇒ Types::UpdateHttpNamespaceResponse
Updates an HTTP namespace.
-
#update_instance_custom_health_status(params = {}) ⇒ Struct
Submits a request to change the health status of a custom health check to healthy or unhealthy.
-
#update_private_dns_namespace(params = {}) ⇒ Types::UpdatePrivateDnsNamespaceResponse
Updates a private DNS namespace.
-
#update_public_dns_namespace(params = {}) ⇒ Types::UpdatePublicDnsNamespaceResponse
Updates a public DNS namespace.
-
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Submits a request to perform the following operations:.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#create_http_namespace(params = {}) ⇒ Types::CreateHttpNamespaceResponse
Creates an HTTP namespace. Service instances registered using an HTTP
namespace can be discovered using a DiscoverInstances
request but
can't be discovered using DNS.
For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide.
438 439 440 441 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 438 def create_http_namespace(params = {}, = {}) req = build_request(:create_http_namespace, params) req.send_request() end |
#create_private_dns_namespace(params = {}) ⇒ Types::CreatePrivateDnsNamespaceResponse
Creates a private namespace based on DNS, which is visible only inside
a specified Amazon VPC. The namespace defines your service naming
scheme. For example, if you name your namespace example.com
and name
your service backend
, the resulting DNS name for the service is
backend.example.com
. Service instances that are registered using a
private DNS namespace can be discovered using either a
DiscoverInstances
request or using DNS. For the current quota on the
number of namespaces that you can create using the same account, see
Cloud Map quotas in the Cloud Map Developer Guide.
536 537 538 539 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 536 def create_private_dns_namespace(params = {}, = {}) req = build_request(:create_private_dns_namespace, params) req.send_request() end |
#create_public_dns_namespace(params = {}) ⇒ Types::CreatePublicDnsNamespaceResponse
Creates a public namespace based on DNS, which is visible on the
internet. The namespace defines your service naming scheme. For
example, if you name your namespace example.com
and name your
service backend
, the resulting DNS name for the service is
backend.example.com
. You can discover instances that were registered
with a public DNS namespace by using either a DiscoverInstances
request or using DNS. For the current quota on the number of
namespaces that you can create using the same account, see Cloud Map
quotas in the Cloud Map Developer Guide.
627 628 629 630 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 627 def create_public_dns_namespace(params = {}, = {}) req = build_request(:create_public_dns_namespace, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates a service. This action defines the configuration for the following entities:
For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
A
AAAA
A
andAAAA
SRV
CNAME
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
857 858 859 860 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 857 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
900 901 902 903 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 900 def delete_namespace(params = {}, = {}) req = build_request(:delete_namespace, params) req.send_request() end |
#delete_service(params = {}) ⇒ Struct
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
936 937 938 939 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 936 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() end |
#deregister_instance(params = {}) ⇒ Types::DeregisterInstanceResponse
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
989 990 991 992 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 989 def deregister_instance(params = {}, = {}) req = build_request(:deregister_instance, params) req.send_request() end |
#discover_instances(params = {}) ⇒ Types::DiscoverInstancesResponse
Discovers registered instances for a specified namespace and service.
You can use DiscoverInstances
to discover instances for any type of
namespace. For public and private DNS namespaces, you can also use DNS
queries to discover instances.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1109 def discover_instances(params = {}, = {}) req = build_request(:discover_instances, params) req.send_request() end |
#get_instance(params = {}) ⇒ Types::GetInstanceResponse
Gets information about a specified instance.
1168 1169 1170 1171 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1168 def get_instance(params = {}, = {}) req = build_request(:get_instance, params) req.send_request() end |
#get_instances_health_status(params = {}) ⇒ Types::GetInstancesHealthStatusResponse
Gets the current health status (Healthy
, Unhealthy
, or Unknown
)
of one or more instances that are associated with a specified service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1257 def get_instances_health_status(params = {}, = {}) req = build_request(:get_instances_health_status, params) req.send_request() end |
#get_namespace(params = {}) ⇒ Types::GetNamespaceResponse
Gets information about a namespace.
1324 1325 1326 1327 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1324 def get_namespace(params = {}, = {}) req = build_request(:get_namespace, params) req.send_request() end |
#get_operation(params = {}) ⇒ Types::GetOperationResponse
Gets information about any operation that returns an operation ID in
the response, such as a CreateService
request.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1393 def get_operation(params = {}, = {}) req = build_request(:get_operation, params) req.send_request() end |
#get_service(params = {}) ⇒ Types::GetServiceResponse
Gets the settings for a specified service.
1465 1466 1467 1468 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1465 def get_service(params = {}, = {}) req = build_request(:get_service, params) req.send_request() end |
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
Lists summary information about the instances that you registered by using a specified service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1538 def list_instances(params = {}, = {}) req = build_request(:list_instances, params) req.send_request() end |
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists summary information about the namespaces that were created by the current account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1672 1673 1674 1675 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1672 def list_namespaces(params = {}, = {}) req = build_request(:list_namespaces, params) req.send_request() end |
#list_operations(params = {}) ⇒ Types::ListOperationsResponse
Lists operations that match the criteria that you specify.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1775 def list_operations(params = {}, = {}) req = build_request(:list_operations, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists summary information for all the services that are associated with one or more specified namespaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1885 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags for the specified resource.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 1939 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_instance(params = {}) ⇒ Types::RegisterInstanceResponse
Creates or updates one or more records and, optionally, creates a
health check based on the settings in a specified service. When you
submit a RegisterInstance
request, the following occurs:
For each DNS record that you define in the service that's specified by
ServiceId
, a record is created or updated in the hosted zone that's associated with the corresponding namespace.If the service includes
HealthCheckConfig
, a health check is created based on the settings in the health check configuration.The health check, if any, is associated with each of the new or updated records.
One RegisterInstance
request must complete before you can submit
another request and specify the same service ID and instance ID.
For more information, see CreateService.
When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
If the health check is healthy: returns all the records
If the health check is unhealthy: returns the applicable value for the last healthy instance
If you didn't specify a health check configuration: returns all the records
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
2181 2182 2183 2184 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2181 def register_instance(params = {}, = {}) req = build_request(:register_instance, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to the specified resource.
2238 2239 2240 2241 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2238 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
2282 2283 2284 2285 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2282 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_http_namespace(params = {}) ⇒ Types::UpdateHttpNamespaceResponse
Updates an HTTP namespace.
2326 2327 2328 2329 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2326 def update_http_namespace(params = {}, = {}) req = build_request(:update_http_namespace, params) req.send_request() end |
#update_instance_custom_health_status(params = {}) ⇒ Struct
Submits a request to change the health status of a custom health check to healthy or unhealthy.
You can use UpdateInstanceCustomHealthStatus
to change the status
only for custom health checks, which you define using
HealthCheckCustomConfig
when you create a service. You can't use it
to change the status for Route 53 health checks, which you define
using HealthCheckConfig
.
For more information, see HealthCheckCustomConfig.
2382 2383 2384 2385 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2382 def update_instance_custom_health_status(params = {}, = {}) req = build_request(:update_instance_custom_health_status, params) req.send_request() end |
#update_private_dns_namespace(params = {}) ⇒ Types::UpdatePrivateDnsNamespaceResponse
Updates a private DNS namespace.
2433 2434 2435 2436 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2433 def update_private_dns_namespace(params = {}, = {}) req = build_request(:update_private_dns_namespace, params) req.send_request() end |
#update_public_dns_namespace(params = {}) ⇒ Types::UpdatePublicDnsNamespaceResponse
Updates a public DNS namespace.
2484 2485 2486 2487 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2484 def update_public_dns_namespace(params = {}, = {}) req = build_request(:update_public_dns_namespace, params) req.send_request() end |
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Submits a request to perform the following operations:
Update the TTL setting for existing
DnsRecords
configurationsAdd, update, or delete
HealthCheckConfig
for a specified serviceYou can't add, update, or delete a HealthCheckCustomConfig
configuration.
For public and private DNS namespaces, note the following:
If you omit any existing
DnsRecords
orHealthCheckConfig
configurations from anUpdateService
request, the configurations are deleted from the service.If you omit an existing
HealthCheckCustomConfig
configuration from anUpdateService
request, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
2583 2584 2585 2586 |
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/client.rb', line 2583 def update_service(params = {}, = {}) req = build_request(:update_service, params) req.send_request() end |