paws.networking (version 0.1.9)

servicediscovery: AWS Cloud Map

Description

AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.

Usage

servicediscovery(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- servicediscovery(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_http_namespace	Creates an HTTP namespace
create_private_dns_namespace	Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC
create_public_dns_namespace	Creates a public namespace based on DNS, which will be visible on the internet
create_service	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
delete_namespace	Deletes a namespace from the current account
delete_service	Deletes a specified service
deregister_instance	Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance
discover_instances	Discovers registered instances for a specified namespace and service
get_instance	Gets information about a specified instance
get_instances_health_status	Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service
get_namespace	Gets information about a namespace
get_operation	Gets information about any operation that returns an operation ID in the response, such as a CreateService request
get_service	Gets the settings for a specified service
list_instances	Lists summary information about the instances that you registered by using a specified service
list_namespaces	Lists summary information about the namespaces that were created by the current AWS account
list_operations	Lists operations that match the criteria that you specify
list_services	Lists summary information for all the services that are associated with one or more specified namespaces
list_tags_for_resource	Lists tags for the specified resource
register_instance	Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service
tag_resource	Adds one or more tags to the specified resource
untag_resource	Removes one or more tags from the specified resource
update_instance_custom_health_status	Submits a request to change the health status of a custom health check to healthy or unhealthy

Examples

# NOT RUN {
svc <- servicediscovery()
# This example creates an HTTP namespace.
svc$create_http_namespace(
  CreatorRequestId = "example-creator-request-id-0001",
  Description = "Example.com AWS Cloud Map HTTP Namespace",
  Name = "example-http.com"
)
# }
# NOT RUN {
# }