[−][src]Trait rusoto_servicediscovery::ServiceDiscovery

pub trait ServiceDiscovery {
    fn create_http_namespace(
        &self, 
        input: CreateHttpNamespaceRequest
    ) -> RusotoFuture<CreateHttpNamespaceResponse, CreateHttpNamespaceError>;

    fn create_private_dns_namespace(
        &self, 
        input: CreatePrivateDnsNamespaceRequest
    ) -> RusotoFuture<CreatePrivateDnsNamespaceResponse, CreatePrivateDnsNamespaceError>;

    fn create_public_dns_namespace(
        &self, 
        input: CreatePublicDnsNamespaceRequest
    ) -> RusotoFuture<CreatePublicDnsNamespaceResponse, CreatePublicDnsNamespaceError>;

    fn create_service(
        &self, 
        input: CreateServiceRequest
    ) -> RusotoFuture<CreateServiceResponse, CreateServiceError>;

    fn delete_namespace(
        &self, 
        input: DeleteNamespaceRequest
    ) -> RusotoFuture<DeleteNamespaceResponse, DeleteNamespaceError>;

    fn delete_service(
        &self, 
        input: DeleteServiceRequest
    ) -> RusotoFuture<DeleteServiceResponse, DeleteServiceError>;

    fn deregister_instance(
        &self, 
        input: DeregisterInstanceRequest
    ) -> RusotoFuture<DeregisterInstanceResponse, DeregisterInstanceError>;

    fn discover_instances(
        &self, 
        input: DiscoverInstancesRequest
    ) -> RusotoFuture<DiscoverInstancesResponse, DiscoverInstancesError>;

    fn get_instance(
        &self, 
        input: GetInstanceRequest
    ) -> RusotoFuture<GetInstanceResponse, GetInstanceError>;

    fn get_instances_health_status(
        &self, 
        input: GetInstancesHealthStatusRequest
    ) -> RusotoFuture<GetInstancesHealthStatusResponse, GetInstancesHealthStatusError>;

    fn get_namespace(
        &self, 
        input: GetNamespaceRequest
    ) -> RusotoFuture<GetNamespaceResponse, GetNamespaceError>;

    fn get_operation(
        &self, 
        input: GetOperationRequest
    ) -> RusotoFuture<GetOperationResponse, GetOperationError>;

    fn get_service(
        &self, 
        input: GetServiceRequest
    ) -> RusotoFuture<GetServiceResponse, GetServiceError>;

    fn list_instances(
        &self, 
        input: ListInstancesRequest
    ) -> RusotoFuture<ListInstancesResponse, ListInstancesError>;

    fn list_namespaces(
        &self, 
        input: ListNamespacesRequest
    ) -> RusotoFuture<ListNamespacesResponse, ListNamespacesError>;

    fn list_operations(
        &self, 
        input: ListOperationsRequest
    ) -> RusotoFuture<ListOperationsResponse, ListOperationsError>;

    fn list_services(
        &self, 
        input: ListServicesRequest
    ) -> RusotoFuture<ListServicesResponse, ListServicesError>;

    fn register_instance(
        &self, 
        input: RegisterInstanceRequest
    ) -> RusotoFuture<RegisterInstanceResponse, RegisterInstanceError>;

    fn update_instance_custom_health_status(
        &self, 
        input: UpdateInstanceCustomHealthStatusRequest
    ) -> RusotoFuture<(), UpdateInstanceCustomHealthStatusError>;

    fn update_service(
        &self, 
        input: UpdateServiceRequest
    ) -> RusotoFuture<UpdateServiceResponse, UpdateServiceError>;
}

Trait representing the capabilities of the ServiceDiscovery API. ServiceDiscovery clients implement this trait.

Required methods

fn create_http_namespace(
    &self,
    input: CreateHttpNamespaceRequest
) -> RusotoFuture<CreateHttpNamespaceResponse, CreateHttpNamespaceError>

Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn create_private_dns_namespace(
    &self,
    input: CreatePrivateDnsNamespaceRequest
) -> RusotoFuture<CreatePrivateDnsNamespaceResponse, CreatePrivateDnsNamespaceError>

Creates a private namespace based on DNS, which will be 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 will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn create_public_dns_namespace(
    &self,
    input: CreatePublicDnsNamespaceRequest
) -> RusotoFuture<CreatePublicDnsNamespaceResponse, CreatePublicDnsNamespaceError>

Creates a public namespace based on DNS, which will be 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 will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn create_service(
    &self,
    input: CreateServiceRequest
) -> RusotoFuture<CreateServiceResponse, CreateServiceError>

Creates a service, which 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 and AAAA

    • SRV

    • CNAME

  • Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn delete_namespace(
    &self,
    input: DeleteNamespaceRequest
) -> RusotoFuture<DeleteNamespaceResponse, DeleteNamespaceError>

Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

fn delete_service(
    &self,
    input: DeleteServiceRequest
) -> RusotoFuture<DeleteServiceResponse, DeleteServiceError>

Deletes a specified service. If the service still contains one or more registered instances, the request fails.

fn deregister_instance(
    &self,
    input: DeregisterInstanceRequest
) -> RusotoFuture<DeregisterInstanceResponse, DeregisterInstanceError>

Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.

fn discover_instances(
    &self,
    input: DiscoverInstancesRequest
) -> RusotoFuture<DiscoverInstancesResponse, DiscoverInstancesError>

Discovers registered instances for a specified namespace and service.

fn get_instance(
    &self,
    input: GetInstanceRequest
) -> RusotoFuture<GetInstanceResponse, GetInstanceError>

Gets information about a specified instance.

fn get_instances_health_status(
    &self,
    input: GetInstancesHealthStatusRequest
) -> RusotoFuture<GetInstancesHealthStatusResponse, GetInstancesHealthStatusError>

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There is a brief delay between when you register an instance and when the health status for the instance is available.

fn get_namespace(
    &self,
    input: GetNamespaceRequest
) -> RusotoFuture<GetNamespaceResponse, GetNamespaceError>

Gets information about a namespace.

fn get_operation(
    &self,
    input: GetOperationRequest
) -> RusotoFuture<GetOperationResponse, GetOperationError>

Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

To get a list of operations that match specified criteria, see ListOperations.

fn get_service(
    &self,
    input: GetServiceRequest
) -> RusotoFuture<GetServiceResponse, GetServiceError>

Gets the settings for a specified service.

fn list_instances(
    &self,
    input: ListInstancesRequest
) -> RusotoFuture<ListInstancesResponse, ListInstancesError>

Lists summary information about the instances that you registered by using a specified service.

fn list_namespaces(
    &self,
    input: ListNamespacesRequest
) -> RusotoFuture<ListNamespacesResponse, ListNamespacesError>

Lists summary information about the namespaces that were created by the current AWS account.

fn list_operations(
    &self,
    input: ListOperationsRequest
) -> RusotoFuture<ListOperationsResponse, ListOperationsError>

Lists operations that match the criteria that you specify.

fn list_services(
    &self,
    input: ListServicesRequest
) -> RusotoFuture<ListServicesResponse, ListServicesError>

Lists summary information for all the services that are associated with one or more specified namespaces.

fn register_instance(
    &self,
    input: RegisterInstanceRequest
) -> RusotoFuture<RegisterInstanceResponse, RegisterInstanceError>

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 is specified by ServiceId, a record is created or updated in the hosted zone that is 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 AWS 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 limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn update_instance_custom_health_status(
    &self,
    input: UpdateInstanceCustomHealthStatusRequest
) -> RusotoFuture<(), UpdateInstanceCustomHealthStatusError>

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.

fn update_service(
    &self,
    input: UpdateServiceRequest
) -> RusotoFuture<UpdateServiceResponse, UpdateServiceError>

Submits a request to perform the following operations:

  • Add or delete DnsRecords configurations

  • Update the TTL setting for existing DnsRecords configurations

  • Add, update, or delete HealthCheckConfig for a specified service

For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

Loading content...

Implementors

impl ServiceDiscovery for ServiceDiscoveryClient[src]

fn create_http_namespace(
    &self,
    input: CreateHttpNamespaceRequest
) -> RusotoFuture<CreateHttpNamespaceResponse, CreateHttpNamespaceError>[src]

Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn create_private_dns_namespace(
    &self,
    input: CreatePrivateDnsNamespaceRequest
) -> RusotoFuture<CreatePrivateDnsNamespaceResponse, CreatePrivateDnsNamespaceError>[src]

Creates a private namespace based on DNS, which will be 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 will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn create_public_dns_namespace(
    &self,
    input: CreatePublicDnsNamespaceRequest
) -> RusotoFuture<CreatePublicDnsNamespaceResponse, CreatePublicDnsNamespaceError>[src]

Creates a public namespace based on DNS, which will be 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 will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn create_service(
    &self,
    input: CreateServiceRequest
) -> RusotoFuture<CreateServiceResponse, CreateServiceError>[src]

Creates a service, which 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 and AAAA

    • SRV

    • CNAME

  • Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn delete_namespace(
    &self,
    input: DeleteNamespaceRequest
) -> RusotoFuture<DeleteNamespaceResponse, DeleteNamespaceError>[src]

Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

fn delete_service(
    &self,
    input: DeleteServiceRequest
) -> RusotoFuture<DeleteServiceResponse, DeleteServiceError>[src]

Deletes a specified service. If the service still contains one or more registered instances, the request fails.

fn deregister_instance(
    &self,
    input: DeregisterInstanceRequest
) -> RusotoFuture<DeregisterInstanceResponse, DeregisterInstanceError>[src]

Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.

fn discover_instances(
    &self,
    input: DiscoverInstancesRequest
) -> RusotoFuture<DiscoverInstancesResponse, DiscoverInstancesError>[src]

Discovers registered instances for a specified namespace and service.

fn get_instance(
    &self,
    input: GetInstanceRequest
) -> RusotoFuture<GetInstanceResponse, GetInstanceError>[src]

Gets information about a specified instance.

fn get_instances_health_status(
    &self,
    input: GetInstancesHealthStatusRequest
) -> RusotoFuture<GetInstancesHealthStatusResponse, GetInstancesHealthStatusError>[src]

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There is a brief delay between when you register an instance and when the health status for the instance is available.

fn get_namespace(
    &self,
    input: GetNamespaceRequest
) -> RusotoFuture<GetNamespaceResponse, GetNamespaceError>[src]

Gets information about a namespace.

fn get_operation(
    &self,
    input: GetOperationRequest
) -> RusotoFuture<GetOperationResponse, GetOperationError>[src]

Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

To get a list of operations that match specified criteria, see ListOperations.

fn get_service(
    &self,
    input: GetServiceRequest
) -> RusotoFuture<GetServiceResponse, GetServiceError>[src]

Gets the settings for a specified service.

fn list_instances(
    &self,
    input: ListInstancesRequest
) -> RusotoFuture<ListInstancesResponse, ListInstancesError>[src]

Lists summary information about the instances that you registered by using a specified service.

fn list_namespaces(
    &self,
    input: ListNamespacesRequest
) -> RusotoFuture<ListNamespacesResponse, ListNamespacesError>[src]

Lists summary information about the namespaces that were created by the current AWS account.

fn list_operations(
    &self,
    input: ListOperationsRequest
) -> RusotoFuture<ListOperationsResponse, ListOperationsError>[src]

Lists operations that match the criteria that you specify.

fn list_services(
    &self,
    input: ListServicesRequest
) -> RusotoFuture<ListServicesResponse, ListServicesError>[src]

Lists summary information for all the services that are associated with one or more specified namespaces.

fn register_instance(
    &self,
    input: RegisterInstanceRequest
) -> RusotoFuture<RegisterInstanceResponse, RegisterInstanceError>[src]

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 is specified by ServiceId, a record is created or updated in the hosted zone that is 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 AWS 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 limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

fn update_instance_custom_health_status(
    &self,
    input: UpdateInstanceCustomHealthStatusRequest
) -> RusotoFuture<(), UpdateInstanceCustomHealthStatusError>[src]

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.

fn update_service(
    &self,
    input: UpdateServiceRequest
) -> RusotoFuture<UpdateServiceResponse, UpdateServiceError>[src]

Submits a request to perform the following operations:

  • Add or delete DnsRecords configurations

  • Update the TTL setting for existing DnsRecords configurations

  • Add, update, or delete HealthCheckConfig for a specified service

For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

Loading content...