NAME

Paws::ServiceDiscovery - Perl Interface to AWS Amazon Route 53 Auto Naming

SYNOPSIS

use Paws;

my $obj = Paws->service('ServiceDiscovery');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14

METHODS

CreatePrivateDnsNamespace

Name => Str
Vpc => Str
[CreatorRequestId => Str]
[Description => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::CreatePrivateDnsNamespace

Returns: a Paws::ServiceDiscovery::CreatePrivateDnsNamespaceResponse instance

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 Limits on Auto Naming (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming) in the Route 53 Developer Guide.

CreatePublicDnsNamespace

Name => Str
[CreatorRequestId => Str]
[Description => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::CreatePublicDnsNamespace

Returns: a Paws::ServiceDiscovery::CreatePublicDnsNamespaceResponse instance

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 Limits on Auto Naming (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming) in the Route 53 Developer Guide.

CreateService

DnsConfig => Paws::ServiceDiscovery::DnsConfig
Name => Str
[CreatorRequestId => Str]
[Description => Str]
[HealthCheckConfig => Paws::ServiceDiscovery::HealthCheckConfig]
[HealthCheckCustomConfig => Paws::ServiceDiscovery::HealthCheckCustomConfig]

Each argument is described in detail in: Paws::ServiceDiscovery::CreateService

Returns: a Paws::ServiceDiscovery::CreateServiceResponse instance

Creates a service, which defines the configuration for the following entities:

Up to three records (A, AAAA, and SRV) or one CNAME record
Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and Amazon Route 53 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 Limits on Auto Naming (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming) in the Route 53 Developer Guide.

DeleteNamespace

Id => Str

Each argument is described in detail in: Paws::ServiceDiscovery::DeleteNamespace

Returns: a Paws::ServiceDiscovery::DeleteNamespaceResponse instance

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

DeleteService

Id => Str

Each argument is described in detail in: Paws::ServiceDiscovery::DeleteService

Returns: a Paws::ServiceDiscovery::DeleteServiceResponse instance

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

DeregisterInstance

InstanceId => Str
ServiceId => Str

Each argument is described in detail in: Paws::ServiceDiscovery::DeregisterInstance

Returns: a Paws::ServiceDiscovery::DeregisterInstanceResponse instance

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

GetInstance

InstanceId => Str
ServiceId => Str

Each argument is described in detail in: Paws::ServiceDiscovery::GetInstance

Returns: a Paws::ServiceDiscovery::GetInstanceResponse instance

Gets information about a specified instance.

GetInstancesHealthStatus

ServiceId => Str
[Instances => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::GetInstancesHealthStatus

Returns: a Paws::ServiceDiscovery::GetInstancesHealthStatusResponse instance

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.

GetNamespace

Id => Str

Each argument is described in detail in: Paws::ServiceDiscovery::GetNamespace

Returns: a Paws::ServiceDiscovery::GetNamespaceResponse instance

Gets information about a namespace.

GetOperation

OperationId => Str

Each argument is described in detail in: Paws::ServiceDiscovery::GetOperation

Returns: a Paws::ServiceDiscovery::GetOperationResponse instance

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.

GetService

Id => Str

Each argument is described in detail in: Paws::ServiceDiscovery::GetService

Returns: a Paws::ServiceDiscovery::GetServiceResponse instance

Gets the settings for a specified service.

ListInstances

ServiceId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::ListInstances

Returns: a Paws::ServiceDiscovery::ListInstancesResponse instance

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

ListNamespaces

[Filters => ArrayRef[Paws::ServiceDiscovery::NamespaceFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::ListNamespaces

Returns: a Paws::ServiceDiscovery::ListNamespacesResponse instance

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

ListOperations

[Filters => ArrayRef[Paws::ServiceDiscovery::OperationFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::ListOperations

Returns: a Paws::ServiceDiscovery::ListOperationsResponse instance

Lists operations that match the criteria that you specify.

ListServices

[Filters => ArrayRef[Paws::ServiceDiscovery::ServiceFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::ListServices

Returns: a Paws::ServiceDiscovery::ListServicesResponse instance

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

RegisterInstance

Attributes => Paws::ServiceDiscovery::Attributes
InstanceId => Str
ServiceId => Str
[CreatorRequestId => Str]

Each argument is described in detail in: Paws::ServiceDiscovery::RegisterInstance

Returns: a Paws::ServiceDiscovery::RegisterInstanceResponse instance

Creates or updates one or more records and optionally a health check based on the settings in a specified service. When you submit a RegisterInstance request, Amazon Route 53 does the following:

For each DNS record that you define in the service specified by ServiceId, creates or updates a record in the hosted zone that is associated with the corresponding namespace
If the service includes HealthCheckConfig, creates or updates a health check based on the settings in the health check configuration
Associates the health check, if any, with each of the 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 Route 53 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

UpdateInstanceCustomHealthStatus

InstanceId => Str
ServiceId => Str
Status => Str

Each argument is described in detail in: Paws::ServiceDiscovery::UpdateInstanceCustomHealthStatus

Returns: nothing

UpdateService

Id => Str
Service => Paws::ServiceDiscovery::ServiceChange

Each argument is described in detail in: Paws::ServiceDiscovery::UpdateService

Returns: a Paws::ServiceDiscovery::UpdateServiceResponse instance

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

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, Amazon Route 53 also updates the corresponding settings in all the records and health checks that were created by using the specified service.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllInstances(sub { },ServiceId => Str, [MaxResults => Int, NextToken => Str])

ListAllInstances(ServiceId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Instances, passing the object as the first parameter, and the string 'Instances' as the second parameter

If not, it will return a a Paws::ServiceDiscovery::ListInstancesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllNamespaces(sub { },[Filters => ArrayRef[Paws::ServiceDiscovery::NamespaceFilter], MaxResults => Int, NextToken => Str])

ListAllNamespaces([Filters => ArrayRef[Paws::ServiceDiscovery::NamespaceFilter], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Namespaces, passing the object as the first parameter, and the string 'Namespaces' as the second parameter

If not, it will return a a Paws::ServiceDiscovery::ListNamespacesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllOperations(sub { },[Filters => ArrayRef[Paws::ServiceDiscovery::OperationFilter], MaxResults => Int, NextToken => Str])

ListAllOperations([Filters => ArrayRef[Paws::ServiceDiscovery::OperationFilter], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Operations, passing the object as the first parameter, and the string 'Operations' as the second parameter

If not, it will return a a Paws::ServiceDiscovery::ListOperationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllServices(sub { },[Filters => ArrayRef[Paws::ServiceDiscovery::ServiceFilter], MaxResults => Int, NextToken => Str])

ListAllServices([Filters => ArrayRef[Paws::ServiceDiscovery::ServiceFilter], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Services, passing the object as the first parameter, and the string 'Services' as the second parameter

If not, it will return a a Paws::ServiceDiscovery::ListServicesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws::SDK::Config

CPAN shell

perl -MCPAN -e shell
install Paws::SDK::Config

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

METHODS

CreatePrivateDnsNamespace

CreatePublicDnsNamespace

CreateService

DeleteNamespace

DeleteService

DeregisterInstance

GetInstance

GetInstancesHealthStatus

GetNamespace

GetOperation

GetService

ListInstances

ListNamespaces

ListOperations

ListServices

RegisterInstance

UpdateInstanceCustomHealthStatus

UpdateService

PAGINATORS

ListAllInstances(sub { },ServiceId => Str, [MaxResults => Int, NextToken => Str])

ListAllInstances(ServiceId => Str, [MaxResults => Int, NextToken => Str])

ListAllNamespaces(sub { },[Filters => ArrayRef[Paws::ServiceDiscovery::NamespaceFilter], MaxResults => Int, NextToken => Str])

ListAllNamespaces([Filters => ArrayRef[Paws::ServiceDiscovery::NamespaceFilter], MaxResults => Int, NextToken => Str])

ListAllOperations(sub { },[Filters => ArrayRef[Paws::ServiceDiscovery::OperationFilter], MaxResults => Int, NextToken => Str])

ListAllOperations([Filters => ArrayRef[Paws::ServiceDiscovery::OperationFilter], MaxResults => Int, NextToken => Str])

ListAllServices(sub { },[Filters => ArrayRef[Paws::ServiceDiscovery::ServiceFilter], MaxResults => Int, NextToken => Str])

ListAllServices([Filters => ArrayRef[Paws::ServiceDiscovery::ServiceFilter], MaxResults => Int, NextToken => Str])

SEE ALSO

BUGS and CONTRIBUTIONS

Module Install Instructions

Keyboard Shortcuts