Client

servicediscovery

R Documentation

AWS Cloud Map¶

Description¶

Cloud Map

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, 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(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- servicediscovery(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_http_namespace: Creates an HTTP namespace
create_private_dns_namespace: Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC
create_public_dns_namespace: Creates a public namespace based on DNS, which is visible on the internet
create_service: Creates a service
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 Cloud Map created for the specified instance
discover_instances: Discovers registered instances for a specified namespace and service
discover_instances_revision: Discovers the increasing revision associated with an instance
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 CreateHttpNamespace 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 Amazon Web Services 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_http_namespace: Updates an HTTP namespace
update_instance_custom_health_status: Submits a request to change the health status of a custom health check to healthy or unhealthy
update_private_dns_namespace: Updates a private DNS namespace
update_public_dns_namespace: Updates a public DNS namespace
update_service: Submits a request to perform the following operations:

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"
)

## End(Not run)