Documentation ¶
Overview ¶
Package servicediscovery provides the client and types for making API requests to Amazon Route 53 Auto Naming.
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.
See https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14 for more information on this service.
See servicediscovery package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/servicediscovery/
Using the Client ¶
To Amazon Route 53 Auto Naming with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Route 53 Auto Naming client ServiceDiscovery for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/servicediscovery/#New
Index ¶
- Constants
- type CreatePrivateDnsNamespaceInput
- type CreatePrivateDnsNamespaceOutput
- type CreatePrivateDnsNamespaceRequest
- type CreatePublicDnsNamespaceInput
- type CreatePublicDnsNamespaceOutput
- type CreatePublicDnsNamespaceRequest
- type CreateServiceInput
- type CreateServiceOutput
- type CreateServiceRequest
- type CustomHealthStatus
- type DeleteNamespaceInput
- type DeleteNamespaceOutput
- type DeleteNamespaceRequest
- type DeleteServiceInput
- type DeleteServiceOutput
- type DeleteServiceRequest
- type DeregisterInstanceInput
- type DeregisterInstanceOutput
- type DeregisterInstanceRequest
- type DnsConfig
- type DnsConfigChange
- type DnsProperties
- type DnsRecord
- type FilterCondition
- type GetInstanceInput
- type GetInstanceOutput
- type GetInstanceRequest
- type GetInstancesHealthStatusInput
- type GetInstancesHealthStatusOutput
- type GetInstancesHealthStatusPager
- type GetInstancesHealthStatusRequest
- type GetNamespaceInput
- type GetNamespaceOutput
- type GetNamespaceRequest
- type GetOperationInput
- type GetOperationOutput
- type GetOperationRequest
- type GetServiceInput
- type GetServiceOutput
- type GetServiceRequest
- type HealthCheckConfig
- type HealthCheckCustomConfig
- type HealthCheckType
- type HealthStatus
- type Instance
- type InstanceSummary
- type ListInstancesInput
- type ListInstancesOutput
- type ListInstancesPager
- type ListInstancesRequest
- type ListNamespacesInput
- type ListNamespacesOutput
- type ListNamespacesPager
- type ListNamespacesRequest
- type ListOperationsInput
- type ListOperationsOutput
- type ListOperationsPager
- type ListOperationsRequest
- type ListServicesInput
- type ListServicesOutput
- type ListServicesPager
- type ListServicesRequest
- type Namespace
- type NamespaceFilter
- type NamespaceFilterName
- type NamespaceProperties
- type NamespaceSummary
- type NamespaceType
- type Operation
- type OperationFilter
- type OperationFilterName
- type OperationStatus
- type OperationSummary
- type OperationTargetType
- type OperationType
- type RecordType
- type RegisterInstanceInput
- type RegisterInstanceOutput
- type RegisterInstanceRequest
- type RoutingPolicy
- type Service
- type ServiceChange
- type ServiceDiscovery
- func (c *ServiceDiscovery) CreatePrivateDnsNamespaceRequest(input *CreatePrivateDnsNamespaceInput) CreatePrivateDnsNamespaceRequest
- func (c *ServiceDiscovery) CreatePublicDnsNamespaceRequest(input *CreatePublicDnsNamespaceInput) CreatePublicDnsNamespaceRequest
- func (c *ServiceDiscovery) CreateServiceRequest(input *CreateServiceInput) CreateServiceRequest
- func (c *ServiceDiscovery) DeleteNamespaceRequest(input *DeleteNamespaceInput) DeleteNamespaceRequest
- func (c *ServiceDiscovery) DeleteServiceRequest(input *DeleteServiceInput) DeleteServiceRequest
- func (c *ServiceDiscovery) DeregisterInstanceRequest(input *DeregisterInstanceInput) DeregisterInstanceRequest
- func (c *ServiceDiscovery) GetInstanceRequest(input *GetInstanceInput) GetInstanceRequest
- func (c *ServiceDiscovery) GetInstancesHealthStatusRequest(input *GetInstancesHealthStatusInput) GetInstancesHealthStatusRequest
- func (c *ServiceDiscovery) GetNamespaceRequest(input *GetNamespaceInput) GetNamespaceRequest
- func (c *ServiceDiscovery) GetOperationRequest(input *GetOperationInput) GetOperationRequest
- func (c *ServiceDiscovery) GetServiceRequest(input *GetServiceInput) GetServiceRequest
- func (c *ServiceDiscovery) ListInstancesRequest(input *ListInstancesInput) ListInstancesRequest
- func (c *ServiceDiscovery) ListNamespacesRequest(input *ListNamespacesInput) ListNamespacesRequest
- func (c *ServiceDiscovery) ListOperationsRequest(input *ListOperationsInput) ListOperationsRequest
- func (c *ServiceDiscovery) ListServicesRequest(input *ListServicesInput) ListServicesRequest
- func (c *ServiceDiscovery) RegisterInstanceRequest(input *RegisterInstanceInput) RegisterInstanceRequest
- func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest(input *UpdateInstanceCustomHealthStatusInput) UpdateInstanceCustomHealthStatusRequest
- func (c *ServiceDiscovery) UpdateServiceRequest(input *UpdateServiceInput) UpdateServiceRequest
- type ServiceFilter
- type ServiceFilterName
- type ServiceSummary
- type UpdateInstanceCustomHealthStatusInput
- type UpdateInstanceCustomHealthStatusOutput
- type UpdateInstanceCustomHealthStatusRequest
- type UpdateServiceInput
- type UpdateServiceOutput
- type UpdateServiceRequest
Constants ¶
const ( // ErrCodeCustomHealthNotFound for service response error code // "CustomHealthNotFound". ErrCodeCustomHealthNotFound = "CustomHealthNotFound" // ErrCodeDuplicateRequest for service response error code // "DuplicateRequest". // // The operation is already in progress. ErrCodeDuplicateRequest = "DuplicateRequest" // ErrCodeInstanceNotFound for service response error code // "InstanceNotFound". // // No instance exists with the specified ID, or the instance was recently registered, // and information about the instance hasn't propagated yet. ErrCodeInstanceNotFound = "InstanceNotFound" // ErrCodeInvalidInput for service response error code // "InvalidInput". // // One or more specified values aren't valid. For example, when you're creating // a namespace, the value of Name might not be a valid DNS name. ErrCodeInvalidInput = "InvalidInput" // ErrCodeNamespaceAlreadyExists for service response error code // "NamespaceAlreadyExists". // // The namespace that you're trying to create already exists. ErrCodeNamespaceAlreadyExists = "NamespaceAlreadyExists" // ErrCodeNamespaceNotFound for service response error code // "NamespaceNotFound". // // No namespace exists with the specified ID. ErrCodeNamespaceNotFound = "NamespaceNotFound" // ErrCodeOperationNotFound for service response error code // "OperationNotFound". // // No operation exists with the specified ID. ErrCodeOperationNotFound = "OperationNotFound" // ErrCodeResourceInUse for service response error code // "ResourceInUse". // // The specified resource can't be deleted because it contains other resources. // For example, you can't delete a service that contains any instances. ErrCodeResourceInUse = "ResourceInUse" // ErrCodeResourceLimitExceeded for service response error code // "ResourceLimitExceeded". // // The resource can't be created because you've reached the limit on the number // of resources. ErrCodeResourceLimitExceeded = "ResourceLimitExceeded" // ErrCodeServiceAlreadyExists for service response error code // "ServiceAlreadyExists". // // The service can't be created because a service with the same name already // exists. ErrCodeServiceAlreadyExists = "ServiceAlreadyExists" // ErrCodeServiceNotFound for service response error code // "ServiceNotFound". // // No service exists with the specified ID. ErrCodeServiceNotFound = "ServiceNotFound" )
const ( ServiceName = "servicediscovery" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreatePrivateDnsNamespaceInput ¶
type CreatePrivateDnsNamespaceInput struct { // A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace // requests to be retried without the risk of executing the operation twice. // CreatorRequestId can be any unique string, for example, a date/time stamp. CreatorRequestId *string `type:"string" idempotencyToken:"true"` // A description for the namespace. Description *string `type:"string"` // The name that you want to assign to this namespace. When you create a namespace, // Amazon Route 53 automatically creates a hosted zone that has the same name // as the namespace. // // Name is a required field Name *string `type:"string" required:"true"` // The ID of the Amazon VPC that you want to associate the namespace with. // // Vpc is a required field Vpc *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespaceRequest
func (CreatePrivateDnsNamespaceInput) GoString ¶
func (s CreatePrivateDnsNamespaceInput) GoString() string
GoString returns the string representation
func (CreatePrivateDnsNamespaceInput) String ¶
func (s CreatePrivateDnsNamespaceInput) String() string
String returns the string representation
func (*CreatePrivateDnsNamespaceInput) Validate ¶
func (s *CreatePrivateDnsNamespaceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePrivateDnsNamespaceOutput ¶
type CreatePrivateDnsNamespaceOutput struct { // A value that you can use to determine whether the request completed successfully. // To get the status of the operation, see GetOperation. OperationId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespaceResponse
func (CreatePrivateDnsNamespaceOutput) GoString ¶
func (s CreatePrivateDnsNamespaceOutput) GoString() string
GoString returns the string representation
func (CreatePrivateDnsNamespaceOutput) SDKResponseMetadata ¶
func (s CreatePrivateDnsNamespaceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreatePrivateDnsNamespaceOutput) String ¶
func (s CreatePrivateDnsNamespaceOutput) String() string
String returns the string representation
type CreatePrivateDnsNamespaceRequest ¶
type CreatePrivateDnsNamespaceRequest struct { *aws.Request Input *CreatePrivateDnsNamespaceInput Copy func(*CreatePrivateDnsNamespaceInput) CreatePrivateDnsNamespaceRequest }
CreatePrivateDnsNamespaceRequest is a API request type for the CreatePrivateDnsNamespace API operation.
func (CreatePrivateDnsNamespaceRequest) Send ¶
func (r CreatePrivateDnsNamespaceRequest) Send() (*CreatePrivateDnsNamespaceOutput, error)
Send marshals and sends the CreatePrivateDnsNamespace API request.
type CreatePublicDnsNamespaceInput ¶
type CreatePublicDnsNamespaceInput struct { // A unique string that identifies the request and that allows failed CreatePublicDnsNamespace // requests to be retried without the risk of executing the operation twice. // CreatorRequestId can be any unique string, for example, a date/time stamp. CreatorRequestId *string `type:"string" idempotencyToken:"true"` // A description for the namespace. Description *string `type:"string"` // The name that you want to assign to this namespace. // // Name is a required field Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespaceRequest
func (CreatePublicDnsNamespaceInput) GoString ¶
func (s CreatePublicDnsNamespaceInput) GoString() string
GoString returns the string representation
func (CreatePublicDnsNamespaceInput) String ¶
func (s CreatePublicDnsNamespaceInput) String() string
String returns the string representation
func (*CreatePublicDnsNamespaceInput) Validate ¶
func (s *CreatePublicDnsNamespaceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePublicDnsNamespaceOutput ¶
type CreatePublicDnsNamespaceOutput struct { // A value that you can use to determine whether the request completed successfully. // To get the status of the operation, see GetOperation. OperationId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespaceResponse
func (CreatePublicDnsNamespaceOutput) GoString ¶
func (s CreatePublicDnsNamespaceOutput) GoString() string
GoString returns the string representation
func (CreatePublicDnsNamespaceOutput) SDKResponseMetadata ¶
func (s CreatePublicDnsNamespaceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreatePublicDnsNamespaceOutput) String ¶
func (s CreatePublicDnsNamespaceOutput) String() string
String returns the string representation
type CreatePublicDnsNamespaceRequest ¶
type CreatePublicDnsNamespaceRequest struct { *aws.Request Input *CreatePublicDnsNamespaceInput Copy func(*CreatePublicDnsNamespaceInput) CreatePublicDnsNamespaceRequest }
CreatePublicDnsNamespaceRequest is a API request type for the CreatePublicDnsNamespace API operation.
func (CreatePublicDnsNamespaceRequest) Send ¶
func (r CreatePublicDnsNamespaceRequest) Send() (*CreatePublicDnsNamespaceOutput, error)
Send marshals and sends the CreatePublicDnsNamespace API request.
type CreateServiceInput ¶
type CreateServiceInput struct { // A unique string that identifies the request and that allows failed CreateService // requests to be retried without the risk of executing the operation twice. // CreatorRequestId can be any unique string, for example, a date/time stamp. CreatorRequestId *string `type:"string" idempotencyToken:"true"` // A description for the service. Description *string `type:"string"` // A complex type that contains information about the records that you want // Route 53 to create when you register an instance. // // DnsConfig is a required field DnsConfig *DnsConfig `type:"structure" required:"true"` // Public DNS namespaces only. A complex type that contains settings for an // optional health check. If you specify settings for a health check, Route // 53 associates the health check with all the records that you specify in DnsConfig. // // For information about the charges for health checks, see Route 53 Pricing // (http://aws.amazon.com/route53/pricing). HealthCheckConfig *HealthCheckConfig `type:"structure"` HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"` // The name that you want to assign to the service. // // Name is a required field Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateServiceRequest
func (CreateServiceInput) GoString ¶
func (s CreateServiceInput) GoString() string
GoString returns the string representation
func (CreateServiceInput) String ¶
func (s CreateServiceInput) String() string
String returns the string representation
func (*CreateServiceInput) Validate ¶
func (s *CreateServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateServiceOutput ¶
type CreateServiceOutput struct { // A complex type that contains information about the new service. Service *Service `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateServiceResponse
func (CreateServiceOutput) GoString ¶
func (s CreateServiceOutput) GoString() string
GoString returns the string representation
func (CreateServiceOutput) SDKResponseMetadata ¶
func (s CreateServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateServiceOutput) String ¶
func (s CreateServiceOutput) String() string
String returns the string representation
type CreateServiceRequest ¶
type CreateServiceRequest struct { *aws.Request Input *CreateServiceInput Copy func(*CreateServiceInput) CreateServiceRequest }
CreateServiceRequest is a API request type for the CreateService API operation.
func (CreateServiceRequest) Send ¶
func (r CreateServiceRequest) Send() (*CreateServiceOutput, error)
Send marshals and sends the CreateService API request.
type CustomHealthStatus ¶ added in v0.4.0
type CustomHealthStatus string
const ( CustomHealthStatusHealthy CustomHealthStatus = "HEALTHY" CustomHealthStatusUnhealthy CustomHealthStatus = "UNHEALTHY" )
Enum values for CustomHealthStatus
func (CustomHealthStatus) MarshalValue ¶ added in v0.4.0
func (enum CustomHealthStatus) MarshalValue() (string, error)
func (CustomHealthStatus) MarshalValueBuf ¶ added in v0.4.0
func (enum CustomHealthStatus) MarshalValueBuf(b []byte) ([]byte, error)
type DeleteNamespaceInput ¶
type DeleteNamespaceInput struct { // The ID of the namespace that you want to delete. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespaceRequest
func (DeleteNamespaceInput) GoString ¶
func (s DeleteNamespaceInput) GoString() string
GoString returns the string representation
func (DeleteNamespaceInput) String ¶
func (s DeleteNamespaceInput) String() string
String returns the string representation
func (*DeleteNamespaceInput) Validate ¶
func (s *DeleteNamespaceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteNamespaceOutput ¶
type DeleteNamespaceOutput struct { // A value that you can use to determine whether the request completed successfully. // To get the status of the operation, see GetOperation. OperationId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespaceResponse
func (DeleteNamespaceOutput) GoString ¶
func (s DeleteNamespaceOutput) GoString() string
GoString returns the string representation
func (DeleteNamespaceOutput) SDKResponseMetadata ¶
func (s DeleteNamespaceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteNamespaceOutput) String ¶
func (s DeleteNamespaceOutput) String() string
String returns the string representation
type DeleteNamespaceRequest ¶
type DeleteNamespaceRequest struct { *aws.Request Input *DeleteNamespaceInput Copy func(*DeleteNamespaceInput) DeleteNamespaceRequest }
DeleteNamespaceRequest is a API request type for the DeleteNamespace API operation.
func (DeleteNamespaceRequest) Send ¶
func (r DeleteNamespaceRequest) Send() (*DeleteNamespaceOutput, error)
Send marshals and sends the DeleteNamespace API request.
type DeleteServiceInput ¶
type DeleteServiceInput struct { // The ID of the service that you want to delete. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteServiceRequest
func (DeleteServiceInput) GoString ¶
func (s DeleteServiceInput) GoString() string
GoString returns the string representation
func (DeleteServiceInput) String ¶
func (s DeleteServiceInput) String() string
String returns the string representation
func (*DeleteServiceInput) Validate ¶
func (s *DeleteServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteServiceOutput ¶
type DeleteServiceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteServiceResponse
func (DeleteServiceOutput) GoString ¶
func (s DeleteServiceOutput) GoString() string
GoString returns the string representation
func (DeleteServiceOutput) SDKResponseMetadata ¶
func (s DeleteServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteServiceOutput) String ¶
func (s DeleteServiceOutput) String() string
String returns the string representation
type DeleteServiceRequest ¶
type DeleteServiceRequest struct { *aws.Request Input *DeleteServiceInput Copy func(*DeleteServiceInput) DeleteServiceRequest }
DeleteServiceRequest is a API request type for the DeleteService API operation.
func (DeleteServiceRequest) Send ¶
func (r DeleteServiceRequest) Send() (*DeleteServiceOutput, error)
Send marshals and sends the DeleteService API request.
type DeregisterInstanceInput ¶
type DeregisterInstanceInput struct { // The value that you specified for Id in the RegisterInstance request. // // InstanceId is a required field InstanceId *string `type:"string" required:"true"` // The ID of the service that the instance is associated with. // // ServiceId is a required field ServiceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstanceRequest
func (DeregisterInstanceInput) GoString ¶
func (s DeregisterInstanceInput) GoString() string
GoString returns the string representation
func (DeregisterInstanceInput) String ¶
func (s DeregisterInstanceInput) String() string
String returns the string representation
func (*DeregisterInstanceInput) Validate ¶
func (s *DeregisterInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterInstanceOutput ¶
type DeregisterInstanceOutput struct { // A value that you can use to determine whether the request completed successfully. // For more information, see GetOperation. OperationId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstanceResponse
func (DeregisterInstanceOutput) GoString ¶
func (s DeregisterInstanceOutput) GoString() string
GoString returns the string representation
func (DeregisterInstanceOutput) SDKResponseMetadata ¶
func (s DeregisterInstanceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeregisterInstanceOutput) String ¶
func (s DeregisterInstanceOutput) String() string
String returns the string representation
type DeregisterInstanceRequest ¶
type DeregisterInstanceRequest struct { *aws.Request Input *DeregisterInstanceInput Copy func(*DeregisterInstanceInput) DeregisterInstanceRequest }
DeregisterInstanceRequest is a API request type for the DeregisterInstance API operation.
func (DeregisterInstanceRequest) Send ¶
func (r DeregisterInstanceRequest) Send() (*DeregisterInstanceOutput, error)
Send marshals and sends the DeregisterInstance API request.
type DnsConfig ¶
type DnsConfig struct { // An array that contains one DnsRecord object for each record that you want // Route 53 to create when you register an instance. // // DnsRecords is a required field DnsRecords []DnsRecord `type:"list" required:"true"` // The ID of the namespace to use for DNS configuration. // // NamespaceId is a required field NamespaceId *string `type:"string" required:"true"` // The routing policy that you want to apply to all records that Route 53 creates // when you register an instance and specify this service. // // If you want to use this service to register instances that create alias records, // specify WEIGHTED for the routing policy. // // You can specify the following values: // // MULTIVALUE // // If you define a health check for the service and the health check is healthy, // Route 53 returns the applicable value for up to eight instances. // // For example, suppose the service includes configurations for one A record // and a health check, and you use the service to register 10 instances. Route // 53 responds to DNS queries with IP addresses for up to eight healthy instances. // If fewer than eight instances are healthy, Route 53 responds to every DNS // query with the IP addresses for all of the healthy instances. // // If you don't define a health check for the service, Route 53 assumes that // all instances are healthy and returns the values for up to eight instances. // // For more information about the multivalue routing policy, see Multivalue // Answer Routing (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue) // in the Route 53 Developer Guide. // // WEIGHTED // // Route 53 returns the applicable value from one randomly selected instance // from among the instances that you registered using the same service. Currently, // all records have the same weight, so you can't route more or less traffic // to any instances. // // For example, suppose the service includes configurations for one A record // and a health check, and you use the service to register 10 instances. Route // 53 responds to DNS queries with the IP address for one randomly selected // instance from among the healthy instances. If no instances are healthy, Route // 53 responds to DNS queries as if all of the instances were healthy. // // If you don't define a health check for the service, Route 53 assumes that // all instances are healthy and returns the applicable value for one randomly // selected instance. // // For more information about the weighted routing policy, see Weighted Routing // (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted) // in the Route 53 Developer Guide. RoutingPolicy RoutingPolicy `type:"string" enum:"true"` // contains filtered or unexported fields }
A complex type that contains information about the records that you want Amazon Route 53 to create when you register an instance. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DnsConfig
type DnsConfigChange ¶
type DnsConfigChange struct { // An array that contains one DnsRecord object for each record that you want // Route 53 to create when you register an instance. // // DnsRecords is a required field DnsRecords []DnsRecord `type:"list" required:"true"` // contains filtered or unexported fields }
A complex type that contains information about changes to the records that Route 53 creates when you register an instance. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DnsConfigChange
func (DnsConfigChange) GoString ¶
func (s DnsConfigChange) GoString() string
GoString returns the string representation
func (DnsConfigChange) String ¶
func (s DnsConfigChange) String() string
String returns the string representation
func (*DnsConfigChange) Validate ¶
func (s *DnsConfigChange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DnsProperties ¶
type DnsProperties struct { // The ID for the hosted zone that Route 53 creates when you create a namespace. HostedZoneId *string `type:"string"` // contains filtered or unexported fields }
A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DnsProperties
func (DnsProperties) GoString ¶
func (s DnsProperties) GoString() string
GoString returns the string representation
func (DnsProperties) String ¶
func (s DnsProperties) String() string
String returns the string representation
type DnsRecord ¶
type DnsRecord struct { // The amount of time, in seconds, that you want DNS resolvers to cache the // settings for this record. // // Alias records don't include a TTL because Route 53 uses the TTL for the AWS // resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME // attribute when you submit a RegisterInstance request, the TTL value is ignored. // Always specify a TTL for the service; you can use a service to register instances // that create either alias or non-alias records. // // TTL is a required field TTL *int64 `type:"long" required:"true"` // The type of the resource, which indicates the type of value that Route 53 // returns in response to DNS queries. // // Note the following: // // * A, AAAA, and SRV records: You can specify settings for a maximum of // one A, one AAAA, and one SRV record. You can specify them in any combination. // // * CNAME records: If you specify CNAME for Type, you can't define any other // records. This is a limitation of DNS—you can't create a CNAME record and // any other type of record that has the same name as a CNAME record. // // * Alias records: If you want Route 53 to create an alias record when you // register an instance, specify A or AAAA for Type. // // * All records: You specify settings other than TTL and Type when you register // an instance. // // The following values are supported: // // A // // Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44. // // AAAA // // Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345. // // CNAME // // Route 53 returns the domain name of the resource, such as www.example.com. // Note the following: // // * You specify the domain name that you want to route traffic to when you // register an instance. For more information, see RegisterInstanceRequest$Attributes. // // * You must specify WEIGHTED for the value of RoutingPolicy. // // * You can't specify both CNAME for Type and settings for HealthCheckConfig. // If you do, the request will fail with an InvalidInput error. // // SRV // // Route 53 returns the value for an SRV record. The value for an SRV record // uses the following values: // // priority weight port service-hostname // // Note the following about the values: // // * The values of priority and weight are both set to 1 and can't be changed. // // // * The value of port comes from the value that you specify for the AWS_INSTANCE_PORT // attribute when you submit a RegisterInstance request. // // * The value of service-hostname is a concatenation of the following values: // // The value that you specify for InstanceId when you register an instance. // // The name of the service. // // The name of the namespace. // // For example, if the value of InstanceId is test, the name of the service // is backend, and the name of the namespace is example.com, the value of // service-hostname is: // // test.backend.example.com // // If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, // AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Route 53 automatically // creates A and/or AAAA records that have the same name as the value of service-hostname // in the SRV record. You can ignore these records. // // Type is a required field Type RecordType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
A complex type that contains information about the records that you want Route 53 to create when you register an instance. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DnsRecord
type FilterCondition ¶
type FilterCondition string
const ( FilterConditionEq FilterCondition = "EQ" FilterConditionIn FilterCondition = "IN" FilterConditionBetween FilterCondition = "BETWEEN" )
Enum values for FilterCondition
func (FilterCondition) MarshalValue ¶ added in v0.3.0
func (enum FilterCondition) MarshalValue() (string, error)
func (FilterCondition) MarshalValueBuf ¶ added in v0.3.0
func (enum FilterCondition) MarshalValueBuf(b []byte) ([]byte, error)
type GetInstanceInput ¶
type GetInstanceInput struct { // The ID of the instance that you want to get information about. // // InstanceId is a required field InstanceId *string `type:"string" required:"true"` // The ID of the service that the instance is associated with. // // ServiceId is a required field ServiceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstanceRequest
func (GetInstanceInput) GoString ¶
func (s GetInstanceInput) GoString() string
GoString returns the string representation
func (GetInstanceInput) String ¶
func (s GetInstanceInput) String() string
String returns the string representation
func (*GetInstanceInput) Validate ¶
func (s *GetInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetInstanceOutput ¶
type GetInstanceOutput struct { // A complex type that contains information about a specified instance. Instance *Instance `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstanceResponse
func (GetInstanceOutput) GoString ¶
func (s GetInstanceOutput) GoString() string
GoString returns the string representation
func (GetInstanceOutput) SDKResponseMetadata ¶
func (s GetInstanceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetInstanceOutput) String ¶
func (s GetInstanceOutput) String() string
String returns the string representation
type GetInstanceRequest ¶
type GetInstanceRequest struct { *aws.Request Input *GetInstanceInput Copy func(*GetInstanceInput) GetInstanceRequest }
GetInstanceRequest is a API request type for the GetInstance API operation.
func (GetInstanceRequest) Send ¶
func (r GetInstanceRequest) Send() (*GetInstanceOutput, error)
Send marshals and sends the GetInstance API request.
type GetInstancesHealthStatusInput ¶
type GetInstancesHealthStatusInput struct { // An array that contains the IDs of all the instances that you want to get // the health status for. // // If you omit Instances, Amazon Route 53 returns the health status for all // the instances that are associated with the specified service. // // To get the IDs for the instances that you've registered by using a specified // service, submit a ListInstances request. Instances []string `min:"1" type:"list"` // The maximum number of instances that you want Route 53 to return in the response // to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, // Route 53 returns up to 100 instances. MaxResults *int64 `min:"1" type:"integer"` // For the first GetInstancesHealthStatus request, omit this value. // // If more than MaxResults instances match the specified criteria, you can submit // another GetInstancesHealthStatus request to get the next group of results. // Specify the value of NextToken from the previous response in the next request. NextToken *string `type:"string"` // The ID of the service that the instance is associated with. // // ServiceId is a required field ServiceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatusRequest
func (GetInstancesHealthStatusInput) GoString ¶
func (s GetInstancesHealthStatusInput) GoString() string
GoString returns the string representation
func (GetInstancesHealthStatusInput) String ¶
func (s GetInstancesHealthStatusInput) String() string
String returns the string representation
func (*GetInstancesHealthStatusInput) Validate ¶
func (s *GetInstancesHealthStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetInstancesHealthStatusOutput ¶
type GetInstancesHealthStatusOutput struct { // If more than MaxResults instances match the specified criteria, you can submit // another GetInstancesHealthStatus request to get the next group of results. // Specify the value of NextToken from the previous response in the next request. NextToken *string `type:"string"` // A complex type that contains the IDs and the health status of the instances // that you specified in the GetInstancesHealthStatus request. Status map[string]HealthStatus `type:"map"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatusResponse
func (GetInstancesHealthStatusOutput) GoString ¶
func (s GetInstancesHealthStatusOutput) GoString() string
GoString returns the string representation
func (GetInstancesHealthStatusOutput) SDKResponseMetadata ¶
func (s GetInstancesHealthStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetInstancesHealthStatusOutput) String ¶
func (s GetInstancesHealthStatusOutput) String() string
String returns the string representation
type GetInstancesHealthStatusPager ¶ added in v0.3.0
GetInstancesHealthStatusPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*GetInstancesHealthStatusPager) CurrentPage ¶ added in v0.3.0
func (p *GetInstancesHealthStatusPager) CurrentPage() *GetInstancesHealthStatusOutput
type GetInstancesHealthStatusRequest ¶
type GetInstancesHealthStatusRequest struct { *aws.Request Input *GetInstancesHealthStatusInput Copy func(*GetInstancesHealthStatusInput) GetInstancesHealthStatusRequest }
GetInstancesHealthStatusRequest is a API request type for the GetInstancesHealthStatus API operation.
func (*GetInstancesHealthStatusRequest) Paginate ¶ added in v0.3.0
func (p *GetInstancesHealthStatusRequest) Paginate(opts ...aws.Option) GetInstancesHealthStatusPager
Paginate pages iterates over the pages of a GetInstancesHealthStatusRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a GetInstancesHealthStatus operation. req := client.GetInstancesHealthStatusRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (GetInstancesHealthStatusRequest) Send ¶
func (r GetInstancesHealthStatusRequest) Send() (*GetInstancesHealthStatusOutput, error)
Send marshals and sends the GetInstancesHealthStatus API request.
type GetNamespaceInput ¶
type GetNamespaceInput struct { // The ID of the namespace that you want to get information about. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespaceRequest
func (GetNamespaceInput) GoString ¶
func (s GetNamespaceInput) GoString() string
GoString returns the string representation
func (GetNamespaceInput) String ¶
func (s GetNamespaceInput) String() string
String returns the string representation
func (*GetNamespaceInput) Validate ¶
func (s *GetNamespaceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetNamespaceOutput ¶
type GetNamespaceOutput struct { // A complex type that contains information about the specified namespace. Namespace *Namespace `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespaceResponse
func (GetNamespaceOutput) GoString ¶
func (s GetNamespaceOutput) GoString() string
GoString returns the string representation
func (GetNamespaceOutput) SDKResponseMetadata ¶
func (s GetNamespaceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetNamespaceOutput) String ¶
func (s GetNamespaceOutput) String() string
String returns the string representation
type GetNamespaceRequest ¶
type GetNamespaceRequest struct { *aws.Request Input *GetNamespaceInput Copy func(*GetNamespaceInput) GetNamespaceRequest }
GetNamespaceRequest is a API request type for the GetNamespace API operation.
func (GetNamespaceRequest) Send ¶
func (r GetNamespaceRequest) Send() (*GetNamespaceOutput, error)
Send marshals and sends the GetNamespace API request.
type GetOperationInput ¶
type GetOperationInput struct { // The ID of the operation that you want to get more information about. // // OperationId is a required field OperationId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperationRequest
func (GetOperationInput) GoString ¶
func (s GetOperationInput) GoString() string
GoString returns the string representation
func (GetOperationInput) String ¶
func (s GetOperationInput) String() string
String returns the string representation
func (*GetOperationInput) Validate ¶
func (s *GetOperationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetOperationOutput ¶
type GetOperationOutput struct { // A complex type that contains information about the operation. Operation *Operation `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperationResponse
func (GetOperationOutput) GoString ¶
func (s GetOperationOutput) GoString() string
GoString returns the string representation
func (GetOperationOutput) SDKResponseMetadata ¶
func (s GetOperationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetOperationOutput) String ¶
func (s GetOperationOutput) String() string
String returns the string representation
type GetOperationRequest ¶
type GetOperationRequest struct { *aws.Request Input *GetOperationInput Copy func(*GetOperationInput) GetOperationRequest }
GetOperationRequest is a API request type for the GetOperation API operation.
func (GetOperationRequest) Send ¶
func (r GetOperationRequest) Send() (*GetOperationOutput, error)
Send marshals and sends the GetOperation API request.
type GetServiceInput ¶
type GetServiceInput struct { // The ID of the service that you want to get settings for. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetServiceRequest
func (GetServiceInput) GoString ¶
func (s GetServiceInput) GoString() string
GoString returns the string representation
func (GetServiceInput) String ¶
func (s GetServiceInput) String() string
String returns the string representation
func (*GetServiceInput) Validate ¶
func (s *GetServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetServiceOutput ¶
type GetServiceOutput struct { // A complex type that contains information about the service. Service *Service `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetServiceResponse
func (GetServiceOutput) GoString ¶
func (s GetServiceOutput) GoString() string
GoString returns the string representation
func (GetServiceOutput) SDKResponseMetadata ¶
func (s GetServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetServiceOutput) String ¶
func (s GetServiceOutput) String() string
String returns the string representation
type GetServiceRequest ¶
type GetServiceRequest struct { *aws.Request Input *GetServiceInput Copy func(*GetServiceInput) GetServiceRequest }
GetServiceRequest is a API request type for the GetService API operation.
func (GetServiceRequest) Send ¶
func (r GetServiceRequest) Send() (*GetServiceOutput, error)
Send marshals and sends the GetService API request.
type HealthCheckConfig ¶
type HealthCheckConfig struct { // The number of consecutive health checks that an endpoint must pass or fail // for Route 53 to change the current status of the endpoint from unhealthy // to healthy or vice versa. For more information, see How Route 53 Determines // Whether an Endpoint Is Healthy (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Route 53 Developer Guide. FailureThreshold *int64 `min:"1" type:"integer"` // The path that you want Route 53 to request when performing health checks. // The path can be any value for which your endpoint will return an HTTP status // code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. // Route 53 automatically adds the DNS name for the service and a leading forward // slash (/) character. ResourcePath *string `type:"string"` // The type of health check that you want to create, which indicates how Route // 53 determines whether an endpoint is healthy. // // You can't change the value of Type after you create a health check. // // You can create the following types of health checks: // // * HTTP: Route 53 tries to establish a TCP connection. If successful, Route // 53 submits an HTTP request and waits for an HTTP status code of 200 or // greater and less than 400. // // * HTTPS: Route 53 tries to establish a TCP connection. If successful, // Route 53 submits an HTTPS request and waits for an HTTP status code of // 200 or greater and less than 400. // // If you specify HTTPS for the value of Type, the endpoint must support TLS // v1.0 or later. // // * TCP: Route 53 tries to establish a TCP connection. // // For more information, see How Route 53 Determines Whether an Endpoint Is // Healthy (http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Route 53 Developer Guide. Type HealthCheckType `type:"string" enum:"true"` // contains filtered or unexported fields }
Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in DnsConfig.
A and AAAA records ¶
If DnsConfig includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
CNAME records ¶
You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.
Request interval ¶
The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.
Health checking regions ¶
Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions (http://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions).
Alias records ¶
When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Route 53 creates an alias record. Note the following:
Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth (http://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth).
If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.
For information about the charges for health checks, see Route 53 Pricing (http://aws.amazon.com/route53/pricing). Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/HealthCheckConfig
func (HealthCheckConfig) GoString ¶
func (s HealthCheckConfig) GoString() string
GoString returns the string representation
func (HealthCheckConfig) String ¶
func (s HealthCheckConfig) String() string
String returns the string representation
func (*HealthCheckConfig) Validate ¶
func (s *HealthCheckConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HealthCheckCustomConfig ¶ added in v0.4.0
type HealthCheckCustomConfig struct { FailureThreshold *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/HealthCheckCustomConfig
func (HealthCheckCustomConfig) GoString ¶ added in v0.4.0
func (s HealthCheckCustomConfig) GoString() string
GoString returns the string representation
func (HealthCheckCustomConfig) String ¶ added in v0.4.0
func (s HealthCheckCustomConfig) String() string
String returns the string representation
func (*HealthCheckCustomConfig) Validate ¶ added in v0.4.0
func (s *HealthCheckCustomConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HealthCheckType ¶
type HealthCheckType string
const ( HealthCheckTypeHttp HealthCheckType = "HTTP" HealthCheckTypeHttps HealthCheckType = "HTTPS" HealthCheckTypeTcp HealthCheckType = "TCP" )
Enum values for HealthCheckType
func (HealthCheckType) MarshalValue ¶ added in v0.3.0
func (enum HealthCheckType) MarshalValue() (string, error)
func (HealthCheckType) MarshalValueBuf ¶ added in v0.3.0
func (enum HealthCheckType) MarshalValueBuf(b []byte) ([]byte, error)
type HealthStatus ¶
type HealthStatus string
const ( HealthStatusHealthy HealthStatus = "HEALTHY" HealthStatusUnhealthy HealthStatus = "UNHEALTHY" HealthStatusUnknown HealthStatus = "UNKNOWN" )
Enum values for HealthStatus
func (HealthStatus) MarshalValue ¶ added in v0.3.0
func (enum HealthStatus) MarshalValue() (string, error)
func (HealthStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum HealthStatus) MarshalValueBuf(b []byte) ([]byte, error)
type Instance ¶
type Instance struct { // A string map that contains the following information for the service that // you specify in ServiceId: // // * The attributes that apply to the records that are defined in the service. // // // * For each attribute, the applicable value. // // Supported attribute keys include the following: // // AWS_ALIAS_DNS_NAME // // If you want Route 53 to create an alias record that routes traffic to an // Elastic Load Balancing load balancer, specify the DNS name that is associated // with the load balancer. For information about how to get the DNS name, see // "DNSName" in the topic AliasTarget (http://docs.aws.amazon.com/http:/docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html). // // Note the following: // // The configuration for the service that is specified by ServiceId must include // settings for an A record, an AAAA record, or both. // // * In the service that is specified by ServiceId, the value of RoutingPolicy // must be WEIGHTED. // // * If the service that is specified by ServiceId includes HealthCheckConfig // settings, Route 53 will create the health check, but it won't associate // the health check with the alias record. // // * Auto naming currently doesn't support creating alias records that route // traffic to AWS resources other than ELB load balancers. // // * If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values // for any of the AWS_INSTANCE attributes. // // AWS_INSTANCE_CNAME // // If the service configuration includes a CNAME record, the domain name that // you want Route 53 to return in response to DNS queries, for example, example.com. // // This value is required if the service specified by ServiceIdincludes settings for an CNAME record. // // AWS_INSTANCE_IPV4 // // If the service configuration includes an A record, the IPv4 address that // you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. // // This value is required if the service specified by ServiceIdincludes settings for an A record. If the service includes settings for an // SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. // // AWS_INSTANCE_IPV6 // // If the service configuration includes an AAAA record, the IPv6 address that // you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. // // This value is required if the service specified by ServiceIdincludes settings for an AAAA record. If the service includes settings for // an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. // // AWS_INSTANCE_PORT // // If the service includes an SRV record, the value that you want Route 53 to // return for the port. // // If the service includes HealthCheckConfig Attributes map[string]string `type:"map"` // A unique string that identifies the request and that allows failed RegisterInstance // requests to be retried without the risk of executing the operation twice. // You must use a unique CreatorRequestId string every time you submit a RegisterInstance // request if you're registering additional instances for the same namespace // and service. CreatorRequestId can be any unique string, for example, a date/time // stamp. CreatorRequestId *string `type:"string"` // An identifier that you want to associate with the instance. Note the following: // // * If the service that is specified by ServiceId includes settings for // an SRV record, the value of InstanceId is automatically included as part // of the value for the SRV record. For more information, see DnsRecord$Type. // // * You can use this value to update an existing instance. // // * To register a new instance, you must specify a value that is unique // among instances that you register by using the same service. // // * If you specify an existing InstanceId and ServiceId, Route 53 updates // the existing records. If there's also an existing health check, Route // 53 deletes the old health check and creates a new one. // // The health check isn't deleted immediately, so it will still appear for a // while if you submit a ListHealthChecks request, for example. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
A complex type that contains information about an instance that Amazon Route 53 creates when you submit a RegisterInstance request. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Instance
type InstanceSummary ¶
type InstanceSummary struct { // A string map that contains the following information: // // * The attributes that are associate with the instance. // // * For each attribute, the applicable value. // // Supported attribute keys include the following: // // * AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic // Load Balancing load balancer, the DNS name that is associated with the // load balancer. // // * AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 // returns in response to DNS queries, for example, example.com. // // * AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns // in response to DNS queries, for example, 192.0.2.44. // // * AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53 // returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. // // * AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns // for the port. In addition, if the service includes HealthCheckConfig, // the port on the endpoint that Route 53 sends requests to. Attributes map[string]string `type:"map"` // The ID for an instance that you created by using a specified service. Id *string `type:"string"` // contains filtered or unexported fields }
A complex type that contains information about the instances that you registered by using a specified service. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/InstanceSummary
func (InstanceSummary) GoString ¶
func (s InstanceSummary) GoString() string
GoString returns the string representation
func (InstanceSummary) String ¶
func (s InstanceSummary) String() string
String returns the string representation
type ListInstancesInput ¶
type ListInstancesInput struct { // The maximum number of instances that you want Amazon Route 53 to return in // the response to a ListInstances request. If you don't specify a value for // MaxResults, Route 53 returns up to 100 instances. MaxResults *int64 `min:"1" type:"integer"` // For the first ListInstances request, omit this value. // // If more than MaxResults instances match the specified criteria, you can submit // another ListInstances request to get the next group of results. Specify the // value of NextToken from the previous response in the next request. NextToken *string `type:"string"` // The ID of the service that you want to list instances for. // // ServiceId is a required field ServiceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstancesRequest
func (ListInstancesInput) GoString ¶
func (s ListInstancesInput) GoString() string
GoString returns the string representation
func (ListInstancesInput) String ¶
func (s ListInstancesInput) String() string
String returns the string representation
func (*ListInstancesInput) Validate ¶
func (s *ListInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListInstancesOutput ¶
type ListInstancesOutput struct { // Summary information about the instances that are associated with the specified // service. Instances []InstanceSummary `type:"list"` // If more than MaxResults instances match the specified criteria, you can submit // another ListInstances request to get the next group of results. Specify the // value of NextToken from the previous response in the next request. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstancesResponse
func (ListInstancesOutput) GoString ¶
func (s ListInstancesOutput) GoString() string
GoString returns the string representation
func (ListInstancesOutput) SDKResponseMetadata ¶
func (s ListInstancesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListInstancesOutput) String ¶
func (s ListInstancesOutput) String() string
String returns the string representation
type ListInstancesPager ¶ added in v0.3.0
ListInstancesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListInstancesPager) CurrentPage ¶ added in v0.3.0
func (p *ListInstancesPager) CurrentPage() *ListInstancesOutput
type ListInstancesRequest ¶
type ListInstancesRequest struct { *aws.Request Input *ListInstancesInput Copy func(*ListInstancesInput) ListInstancesRequest }
ListInstancesRequest is a API request type for the ListInstances API operation.
func (*ListInstancesRequest) Paginate ¶ added in v0.3.0
func (p *ListInstancesRequest) Paginate(opts ...aws.Option) ListInstancesPager
Paginate pages iterates over the pages of a ListInstancesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListInstances operation. req := client.ListInstancesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListInstancesRequest) Send ¶
func (r ListInstancesRequest) Send() (*ListInstancesOutput, error)
Send marshals and sends the ListInstances API request.
type ListNamespacesInput ¶
type ListNamespacesInput struct { // A complex type that contains specifications for the namespaces that you want // to list. // // If you specify more than one filter, a namespace must match all filters to // be returned by ListNamespaces. Filters []NamespaceFilter `type:"list"` // The maximum number of namespaces that you want Amazon Route 53 to return // in the response to a ListNamespaces request. If you don't specify a value // for MaxResults, Route 53 returns up to 100 namespaces. MaxResults *int64 `min:"1" type:"integer"` // For the first ListNamespaces request, omit this value. // // If the response contains NextToken, submit another ListNamespaces request // to get the next group of results. Specify the value of NextToken from the // previous response in the next request. // // Route 53 gets MaxResults namespaces and then filters them based on the specified // criteria. It's possible that no namespaces in the first MaxResults namespaces // matched the specified criteria but that subsequent groups of MaxResults namespaces // do contain namespaces that match the criteria. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespacesRequest
func (ListNamespacesInput) GoString ¶
func (s ListNamespacesInput) GoString() string
GoString returns the string representation
func (ListNamespacesInput) String ¶
func (s ListNamespacesInput) String() string
String returns the string representation
func (*ListNamespacesInput) Validate ¶
func (s *ListNamespacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListNamespacesOutput ¶
type ListNamespacesOutput struct { // An array that contains one NamespaceSummary object for each namespace that // matches the specified filter criteria. Namespaces []NamespaceSummary `type:"list"` // If the response contains NextToken, submit another ListNamespaces request // to get the next group of results. Specify the value of NextToken from the // previous response in the next request. // // Route 53 gets MaxResults namespaces and then filters them based on the specified // criteria. It's possible that no namespaces in the first MaxResults namespaces // matched the specified criteria but that subsequent groups of MaxResults namespaces // do contain namespaces that match the criteria. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespacesResponse
func (ListNamespacesOutput) GoString ¶
func (s ListNamespacesOutput) GoString() string
GoString returns the string representation
func (ListNamespacesOutput) SDKResponseMetadata ¶
func (s ListNamespacesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListNamespacesOutput) String ¶
func (s ListNamespacesOutput) String() string
String returns the string representation
type ListNamespacesPager ¶ added in v0.3.0
ListNamespacesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListNamespacesPager) CurrentPage ¶ added in v0.3.0
func (p *ListNamespacesPager) CurrentPage() *ListNamespacesOutput
type ListNamespacesRequest ¶
type ListNamespacesRequest struct { *aws.Request Input *ListNamespacesInput Copy func(*ListNamespacesInput) ListNamespacesRequest }
ListNamespacesRequest is a API request type for the ListNamespaces API operation.
func (*ListNamespacesRequest) Paginate ¶ added in v0.3.0
func (p *ListNamespacesRequest) Paginate(opts ...aws.Option) ListNamespacesPager
Paginate pages iterates over the pages of a ListNamespacesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListNamespaces operation. req := client.ListNamespacesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListNamespacesRequest) Send ¶
func (r ListNamespacesRequest) Send() (*ListNamespacesOutput, error)
Send marshals and sends the ListNamespaces API request.
type ListOperationsInput ¶
type ListOperationsInput struct { // A complex type that contains specifications for the operations that you want // to list, for example, operations that you started between a specified start // date and end date. // // If you specify more than one filter, an operation must match all filters // to be returned by ListOperations. Filters []OperationFilter `type:"list"` // The maximum number of items that you want Amazon Route 53 to return in the // response to a ListOperations request. If you don't specify a value for MaxResults, // Route 53 returns up to 100 operations. MaxResults *int64 `min:"1" type:"integer"` // For the first ListOperations request, omit this value. // // If the response contains NextToken, submit another ListOperations request // to get the next group of results. Specify the value of NextToken from the // previous response in the next request. // // Route 53 gets MaxResults operations and then filters them based on the specified // criteria. It's possible that no operations in the first MaxResults operations // matched the specified criteria but that subsequent groups of MaxResults operations // do contain operations that match the criteria. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperationsRequest
func (ListOperationsInput) GoString ¶
func (s ListOperationsInput) GoString() string
GoString returns the string representation
func (ListOperationsInput) String ¶
func (s ListOperationsInput) String() string
String returns the string representation
func (*ListOperationsInput) Validate ¶
func (s *ListOperationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListOperationsOutput ¶
type ListOperationsOutput struct { // If the response contains NextToken, submit another ListOperations request // to get the next group of results. Specify the value of NextToken from the // previous response in the next request. // // Route 53 gets MaxResults operations and then filters them based on the specified // criteria. It's possible that no operations in the first MaxResults operations // matched the specified criteria but that subsequent groups of MaxResults operations // do contain operations that match the criteria. NextToken *string `type:"string"` // Summary information about the operations that match the specified criteria. Operations []OperationSummary `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperationsResponse
func (ListOperationsOutput) GoString ¶
func (s ListOperationsOutput) GoString() string
GoString returns the string representation
func (ListOperationsOutput) SDKResponseMetadata ¶
func (s ListOperationsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListOperationsOutput) String ¶
func (s ListOperationsOutput) String() string
String returns the string representation
type ListOperationsPager ¶ added in v0.3.0
ListOperationsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListOperationsPager) CurrentPage ¶ added in v0.3.0
func (p *ListOperationsPager) CurrentPage() *ListOperationsOutput
type ListOperationsRequest ¶
type ListOperationsRequest struct { *aws.Request Input *ListOperationsInput Copy func(*ListOperationsInput) ListOperationsRequest }
ListOperationsRequest is a API request type for the ListOperations API operation.
func (*ListOperationsRequest) Paginate ¶ added in v0.3.0
func (p *ListOperationsRequest) Paginate(opts ...aws.Option) ListOperationsPager
Paginate pages iterates over the pages of a ListOperationsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListOperations operation. req := client.ListOperationsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListOperationsRequest) Send ¶
func (r ListOperationsRequest) Send() (*ListOperationsOutput, error)
Send marshals and sends the ListOperations API request.
type ListServicesInput ¶
type ListServicesInput struct { // A complex type that contains specifications for the namespaces that you want // to list services for. // // If you specify more than one filter, an operation must match all filters // to be returned by ListServices. Filters []ServiceFilter `type:"list"` // The maximum number of services that you want Amazon Route 53 to return in // the response to a ListServices request. If you don't specify a value for // MaxResults, Route 53 returns up to 100 services. MaxResults *int64 `min:"1" type:"integer"` // For the first ListServices request, omit this value. // // If the response contains NextToken, submit another ListServices request to // get the next group of results. Specify the value of NextToken from the previous // response in the next request. // // Route 53 gets MaxResults services and then filters them based on the specified // criteria. It's possible that no services in the first MaxResults services // matched the specified criteria but that subsequent groups of MaxResults services // do contain services that match the criteria. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServicesRequest
func (ListServicesInput) GoString ¶
func (s ListServicesInput) GoString() string
GoString returns the string representation
func (ListServicesInput) String ¶
func (s ListServicesInput) String() string
String returns the string representation
func (*ListServicesInput) Validate ¶
func (s *ListServicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListServicesOutput ¶
type ListServicesOutput struct { // If the response contains NextToken, submit another ListServices request to // get the next group of results. Specify the value of NextToken from the previous // response in the next request. // // Route 53 gets MaxResults services and then filters them based on the specified // criteria. It's possible that no services in the first MaxResults services // matched the specified criteria but that subsequent groups of MaxResults services // do contain services that match the criteria. NextToken *string `type:"string"` // An array that contains one ServiceSummary object for each service that matches // the specified filter criteria. Services []ServiceSummary `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServicesResponse
func (ListServicesOutput) GoString ¶
func (s ListServicesOutput) GoString() string
GoString returns the string representation
func (ListServicesOutput) SDKResponseMetadata ¶
func (s ListServicesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListServicesOutput) String ¶
func (s ListServicesOutput) String() string
String returns the string representation
type ListServicesPager ¶ added in v0.3.0
ListServicesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListServicesPager) CurrentPage ¶ added in v0.3.0
func (p *ListServicesPager) CurrentPage() *ListServicesOutput
type ListServicesRequest ¶
type ListServicesRequest struct { *aws.Request Input *ListServicesInput Copy func(*ListServicesInput) ListServicesRequest }
ListServicesRequest is a API request type for the ListServices API operation.
func (*ListServicesRequest) Paginate ¶ added in v0.3.0
func (p *ListServicesRequest) Paginate(opts ...aws.Option) ListServicesPager
Paginate pages iterates over the pages of a ListServicesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListServices operation. req := client.ListServicesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListServicesRequest) Send ¶
func (r ListServicesRequest) Send() (*ListServicesOutput, error)
Send marshals and sends the ListServices API request.
type Namespace ¶
type Namespace struct { // The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when // you create it. Arn *string `type:"string"` // The date that the namespace was created, in Unix date/time format and Coordinated // Universal Time (UTC). The value of CreateDate is accurate to milliseconds. // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // A unique string that identifies the request and that allows failed requests // to be retried without the risk of executing an operation twice. CreatorRequestId *string `type:"string"` // The description that you specify for the namespace when you create it. Description *string `type:"string"` // The ID of a namespace. Id *string `type:"string"` // The name of the namespace, such as example.com. Name *string `type:"string"` // A complex type that contains information that's specific to the type of the // namespace. Properties *NamespaceProperties `type:"structure"` // The number of services that are associated with the namespace. ServiceCount *int64 `type:"integer"` // The type of the namespace. Valid values are DNS_PUBLIC and DNS_PRIVATE. Type NamespaceType `type:"string" enum:"true"` // contains filtered or unexported fields }
A complex type that contains information about a specified namespace. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Namespace
type NamespaceFilter ¶
type NamespaceFilter struct { // The operator that you want to use to determine whether ListNamespaces returns // a namespace. Valid values for condition include: // // * EQ: When you specify EQ for the condition, you can choose to list only // public namespaces or private namespaces, but not both. EQ is the default // condition and can be omitted. // // * IN: When you specify IN for the condition, you can choose to list public // namespaces, private namespaces, or both. // // * BETWEEN: Not applicable Condition FilterCondition `type:"string" enum:"true"` // Specify TYPE. // // Name is a required field Name NamespaceFilterName `type:"string" required:"true" enum:"true"` // If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE. // // If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, // or both. // // Values is a required field Values []string `type:"list" required:"true"` // contains filtered or unexported fields }
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/NamespaceFilter
func (NamespaceFilter) GoString ¶
func (s NamespaceFilter) GoString() string
GoString returns the string representation
func (NamespaceFilter) String ¶
func (s NamespaceFilter) String() string
String returns the string representation
func (*NamespaceFilter) Validate ¶
func (s *NamespaceFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NamespaceFilterName ¶
type NamespaceFilterName string
const (
NamespaceFilterNameType NamespaceFilterName = "TYPE"
)
Enum values for NamespaceFilterName
func (NamespaceFilterName) MarshalValue ¶ added in v0.3.0
func (enum NamespaceFilterName) MarshalValue() (string, error)
func (NamespaceFilterName) MarshalValueBuf ¶ added in v0.3.0
func (enum NamespaceFilterName) MarshalValueBuf(b []byte) ([]byte, error)
type NamespaceProperties ¶
type NamespaceProperties struct { // A complex type that contains the ID for the hosted zone that Route 53 creates // when you create a namespace. DnsProperties *DnsProperties `type:"structure"` // contains filtered or unexported fields }
A complex type that contains information that is specific to the namespace type. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/NamespaceProperties
func (NamespaceProperties) GoString ¶
func (s NamespaceProperties) GoString() string
GoString returns the string representation
func (NamespaceProperties) String ¶
func (s NamespaceProperties) String() string
String returns the string representation
type NamespaceSummary ¶
type NamespaceSummary struct { // The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when // you create it. Arn *string `type:"string"` // The ID of the namespace. Id *string `type:"string"` // The name of the namespace. When you create a namespace, Route 53 automatically // creates a hosted zone that has the same name as the namespace. Name *string `type:"string"` // The type of the namespace, either public or private. Type NamespaceType `type:"string" enum:"true"` // contains filtered or unexported fields }
A complex type that contains information about a namespace. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/NamespaceSummary
func (NamespaceSummary) GoString ¶
func (s NamespaceSummary) GoString() string
GoString returns the string representation
func (NamespaceSummary) String ¶
func (s NamespaceSummary) String() string
String returns the string representation
type NamespaceType ¶
type NamespaceType string
const ( NamespaceTypeDnsPublic NamespaceType = "DNS_PUBLIC" NamespaceTypeDnsPrivate NamespaceType = "DNS_PRIVATE" )
Enum values for NamespaceType
func (NamespaceType) MarshalValue ¶ added in v0.3.0
func (enum NamespaceType) MarshalValue() (string, error)
func (NamespaceType) MarshalValueBuf ¶ added in v0.3.0
func (enum NamespaceType) MarshalValueBuf(b []byte) ([]byte, error)
type Operation ¶
type Operation struct { // The date and time that the request was submitted, in Unix date/time format // and Coordinated Universal Time (UTC). The value of CreateDate is accurate // to milliseconds. For example, the value 1516925490.087 represents Friday, // January 26, 2018 12:11:30.087 AM. CreateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The code associated with ErrorMessage. Values for ErrorCode include the following: // // * ACCESS_DENIED // // * CANNOT_CREATE_HOSTED_ZONE // // * EXPIRED_TOKEN // // * HOSTED_ZONE_NOT_FOUND // // * INTERNAL_FAILURE // // * INVALID_CHANGE_BATCH // // * THROTTLED_REQUEST ErrorCode *string `type:"string"` // If the value of Status is FAIL, the reason that the operation failed. ErrorMessage *string `type:"string"` // The ID of the operation that you want to get information about. Id *string `type:"string"` // The status of the operation. Values include the following: // // * SUBMITTED: This is the initial state immediately after you submit a // request. // // * PENDING: Route 53 is performing the operation. // // * SUCCESS: The operation succeeded. // // * FAIL: The operation failed. For the failure reason, see ErrorMessage. Status OperationStatus `type:"string" enum:"true"` // The name of the target entity that is associated with the operation: // // * NAMESPACE: The namespace ID is returned in the ResourceId property. // // * SERVICE: The service ID is returned in the ResourceId property. // // * INSTANCE: The instance ID is returned in the ResourceId property. Targets map[string]string `type:"map"` // The name of the operation that is associated with the specified ID. Type OperationType `type:"string" enum:"true"` // The date and time that the value of Status changed to the current value, // in Unix date/time format and Coordinated Universal Time (UTC). The value // of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 // represents Friday, January 26, 2018 12:11:30.087 AM. UpdateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
A complex type that contains information about a specified operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Operation
type OperationFilter ¶
type OperationFilter struct { // The operator that you want to use to determine whether an operation matches // the specified value. Valid values for condition include: // // * EQ: When you specify EQ for the condition, you can specify only one // value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. // EQ is the default condition and can be omitted. // // * IN: When you specify IN for the condition, you can specify a list of // one or more values. IN is supported for STATUS and TYPE. An operation // must match one of the specified values to be returned in the response. // // * BETWEEN: Specify a start date and an end date in Unix date/time format // and Coordinated Universal Time (UTC). The start date must be the first // value. BETWEEN is supported for UPDATE_DATE. Condition FilterCondition `type:"string" enum:"true"` // Specify the operations that you want to get: // // * NAMESPACE_ID: Gets operations related to specified namespaces. // // * SERVICE_ID: Gets operations related to specified services. // // * STATUS: Gets operations based on the status of the operations: SUBMITTED, // PENDING, SUCCEED, or FAIL. // // * TYPE: Gets specified types of operation. // // * UPDATE_DATE: Gets operations that changed status during a specified // date/time range. // // Name is a required field Name OperationFilterName `type:"string" required:"true" enum:"true"` // Specify values that are applicable to the value that you specify for Name: // // * NAMESPACE_ID: Specify one namespace ID. // // * SERVICE_ID: Specify one service ID. // // * STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or // FAIL. // // * TYPE: Specify one or more of the following types: CREATE_NAMESPACE, // DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE. // // * UPDATE_DATE: Specify a start date and an end date in Unix date/time // format and Coordinated Universal Time (UTC). The start date must be the // first value. // // Values is a required field Values []string `type:"list" required:"true"` // contains filtered or unexported fields }
A complex type that lets you select the operations that you want to list. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/OperationFilter
func (OperationFilter) GoString ¶
func (s OperationFilter) GoString() string
GoString returns the string representation
func (OperationFilter) String ¶
func (s OperationFilter) String() string
String returns the string representation
func (*OperationFilter) Validate ¶
func (s *OperationFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OperationFilterName ¶
type OperationFilterName string
const ( OperationFilterNameNamespaceId OperationFilterName = "NAMESPACE_ID" OperationFilterNameServiceId OperationFilterName = "SERVICE_ID" OperationFilterNameStatus OperationFilterName = "STATUS" OperationFilterNameType OperationFilterName = "TYPE" OperationFilterNameUpdateDate OperationFilterName = "UPDATE_DATE" )
Enum values for OperationFilterName
func (OperationFilterName) MarshalValue ¶ added in v0.3.0
func (enum OperationFilterName) MarshalValue() (string, error)
func (OperationFilterName) MarshalValueBuf ¶ added in v0.3.0
func (enum OperationFilterName) MarshalValueBuf(b []byte) ([]byte, error)
type OperationStatus ¶
type OperationStatus string
const ( OperationStatusSubmitted OperationStatus = "SUBMITTED" OperationStatusPending OperationStatus = "PENDING" OperationStatusSuccess OperationStatus = "SUCCESS" OperationStatusFail OperationStatus = "FAIL" )
Enum values for OperationStatus
func (OperationStatus) MarshalValue ¶ added in v0.3.0
func (enum OperationStatus) MarshalValue() (string, error)
func (OperationStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum OperationStatus) MarshalValueBuf(b []byte) ([]byte, error)
type OperationSummary ¶
type OperationSummary struct { // The ID for an operation. Id *string `type:"string"` // The status of the operation. Values include the following: // // * SUBMITTED: This is the initial state immediately after you submit a // request. // // * PENDING: Route 53 is performing the operation. // // * SUCCESS: The operation succeeded. // // * FAIL: The operation failed. For the failure reason, see ErrorMessage. Status OperationStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/OperationSummary
func (OperationSummary) GoString ¶
func (s OperationSummary) GoString() string
GoString returns the string representation
func (OperationSummary) String ¶
func (s OperationSummary) String() string
String returns the string representation
type OperationTargetType ¶
type OperationTargetType string
const ( OperationTargetTypeNamespace OperationTargetType = "NAMESPACE" OperationTargetTypeService OperationTargetType = "SERVICE" OperationTargetTypeInstance OperationTargetType = "INSTANCE" )
Enum values for OperationTargetType
func (OperationTargetType) MarshalValue ¶ added in v0.3.0
func (enum OperationTargetType) MarshalValue() (string, error)
func (OperationTargetType) MarshalValueBuf ¶ added in v0.3.0
func (enum OperationTargetType) MarshalValueBuf(b []byte) ([]byte, error)
type OperationType ¶
type OperationType string
const ( OperationTypeCreateNamespace OperationType = "CREATE_NAMESPACE" OperationTypeDeleteNamespace OperationType = "DELETE_NAMESPACE" OperationTypeUpdateService OperationType = "UPDATE_SERVICE" OperationTypeRegisterInstance OperationType = "REGISTER_INSTANCE" OperationTypeDeregisterInstance OperationType = "DEREGISTER_INSTANCE" )
Enum values for OperationType
func (OperationType) MarshalValue ¶ added in v0.3.0
func (enum OperationType) MarshalValue() (string, error)
func (OperationType) MarshalValueBuf ¶ added in v0.3.0
func (enum OperationType) MarshalValueBuf(b []byte) ([]byte, error)
type RecordType ¶
type RecordType string
const ( RecordTypeSrv RecordType = "SRV" RecordTypeA RecordType = "A" RecordTypeAaaa RecordType = "AAAA" RecordTypeCname RecordType = "CNAME" )
Enum values for RecordType
func (RecordType) MarshalValue ¶ added in v0.3.0
func (enum RecordType) MarshalValue() (string, error)
func (RecordType) MarshalValueBuf ¶ added in v0.3.0
func (enum RecordType) MarshalValueBuf(b []byte) ([]byte, error)
type RegisterInstanceInput ¶
type RegisterInstanceInput struct { // A string map that contains the following information for the service that // you specify in ServiceId: // // * The attributes that apply to the records that are defined in the service. // // // * For each attribute, the applicable value. // // Supported attribute keys include the following: // // AWS_ALIAS_DNS_NAME // // If you want Route 53 to create an alias record that routes traffic to an // Elastic Load Balancing load balancer, specify the DNS name that is associated // with the load balancer. For information about how to get the DNS name, see // "DNSName" in the topic AliasTarget (http://docs.aws.amazon.com/http:/docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html). // // Note the following: // // The configuration for the service that is specified by ServiceId must include // settings for an A record, an AAAA record, or both. // // * In the service that is specified by ServiceId, the value of RoutingPolicy // must be WEIGHTED. // // * If the service that is specified by ServiceId includes HealthCheckConfig // settings, Route 53 will create the health check, but it won't associate // the health check with the alias record. // // * Auto naming currently doesn't support creating alias records that route // traffic to AWS resources other than ELB load balancers. // // * If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values // for any of the AWS_INSTANCE attributes. // // AWS_INSTANCE_CNAME // // If the service configuration includes a CNAME record, the domain name that // you want Route 53 to return in response to DNS queries, for example, example.com. // // This value is required if the service specified by ServiceIdincludes settings for an CNAME record. // // AWS_INSTANCE_IPV4 // // If the service configuration includes an A record, the IPv4 address that // you want Route 53 to return in response to DNS queries, for example, 192.0.2.44. // // This value is required if the service specified by ServiceIdincludes settings for an A record. If the service includes settings for an // SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. // // AWS_INSTANCE_IPV6 // // If the service configuration includes an AAAA record, the IPv6 address that // you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. // // This value is required if the service specified by ServiceIdincludes settings for an AAAA record. If the service includes settings for // an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. // // AWS_INSTANCE_PORT // // If the service includes an SRV record, the value that you want Route 53 to // return for the port. // // If the service includes HealthCheckConfig // // Attributes is a required field Attributes map[string]string `type:"map" required:"true"` // A unique string that identifies the request and that allows failed RegisterInstance // requests to be retried without the risk of executing the operation twice. // You must use a unique CreatorRequestId string every time you submit a RegisterInstance // request if you're registering additional instances for the same namespace // and service. CreatorRequestId can be any unique string, for example, a date/time // stamp. CreatorRequestId *string `type:"string" idempotencyToken:"true"` // An identifier that you want to associate with the instance. Note the following: // // * If the service that is specified by ServiceId includes settings for // an SRV record, the value of InstanceId is automatically included as part // of the value for the SRV record. For more information, see DnsRecord$Type. // // * You can use this value to update an existing instance. // // * To register a new instance, you must specify a value that is unique // among instances that you register by using the same service. // // * If you specify an existing InstanceId and ServiceId, Route 53 updates // the existing records. If there's also an existing health check, Route // 53 deletes the old health check and creates a new one. // // The health check isn't deleted immediately, so it will still appear for a // while if you submit a ListHealthChecks request, for example. // // InstanceId is a required field InstanceId *string `type:"string" required:"true"` // The ID of the service that you want to use for settings for the records and // health check that Route 53 will create. // // ServiceId is a required field ServiceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstanceRequest
func (RegisterInstanceInput) GoString ¶
func (s RegisterInstanceInput) GoString() string
GoString returns the string representation
func (RegisterInstanceInput) String ¶
func (s RegisterInstanceInput) String() string
String returns the string representation
func (*RegisterInstanceInput) Validate ¶
func (s *RegisterInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterInstanceOutput ¶
type RegisterInstanceOutput struct { // A value that you can use to determine whether the request completed successfully. // To get the status of the operation, see GetOperation. OperationId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstanceResponse
func (RegisterInstanceOutput) GoString ¶
func (s RegisterInstanceOutput) GoString() string
GoString returns the string representation
func (RegisterInstanceOutput) SDKResponseMetadata ¶
func (s RegisterInstanceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RegisterInstanceOutput) String ¶
func (s RegisterInstanceOutput) String() string
String returns the string representation
type RegisterInstanceRequest ¶
type RegisterInstanceRequest struct { *aws.Request Input *RegisterInstanceInput Copy func(*RegisterInstanceInput) RegisterInstanceRequest }
RegisterInstanceRequest is a API request type for the RegisterInstance API operation.
func (RegisterInstanceRequest) Send ¶
func (r RegisterInstanceRequest) Send() (*RegisterInstanceOutput, error)
Send marshals and sends the RegisterInstance API request.
type RoutingPolicy ¶ added in v0.3.0
type RoutingPolicy string
const ( RoutingPolicyMultivalue RoutingPolicy = "MULTIVALUE" RoutingPolicyWeighted RoutingPolicy = "WEIGHTED" )
Enum values for RoutingPolicy
func (RoutingPolicy) MarshalValue ¶ added in v0.3.0
func (enum RoutingPolicy) MarshalValue() (string, error)
func (RoutingPolicy) MarshalValueBuf ¶ added in v0.3.0
func (enum RoutingPolicy) MarshalValueBuf(b []byte) ([]byte, error)
type Service ¶
type Service struct { // The Amazon Resource Name (ARN) that Route 53 assigns to the service when // you create it. Arn *string `type:"string"` // The date and time that the service was created, in Unix format and Coordinated // Universal Time (UTC). The value of CreateDate is accurate to milliseconds. // For example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // A unique string that identifies the request and that allows failed requests // to be retried without the risk of executing the operation twice. CreatorRequestId // can be any unique string, for example, a date/time stamp. CreatorRequestId *string `type:"string"` // The description of the service. Description *string `type:"string"` // A complex type that contains information about the records that you want // Route 53 to create when you register an instance. DnsConfig *DnsConfig `type:"structure"` // Public DNS namespaces only. A complex type that contains settings for an // optional health check. If you specify settings for a health check, Route // 53 associates the health check with all the records that you specify in DnsConfig. // // For information about the charges for health checks, see Route 53 Pricing // (http://aws.amazon.com/route53/pricing). HealthCheckConfig *HealthCheckConfig `type:"structure"` HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"` // The ID that Route 53 assigned to the service when you created it. Id *string `type:"string"` // The number of instances that are currently associated with the service. Instances // that were previously associated with the service but that have been deleted // are not included in the count. InstanceCount *int64 `type:"integer"` // The name of the service. Name *string `type:"string"` // contains filtered or unexported fields }
A complex type that contains information about the specified service. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Service
type ServiceChange ¶
type ServiceChange struct { // A description for the service. Description *string `type:"string"` // A complex type that contains information about the records that you want // Route 53 to create when you register an instance. // // DnsConfig is a required field DnsConfig *DnsConfigChange `type:"structure" required:"true"` // Public DNS namespaces only. A complex type that contains settings for an // optional health check. If you specify settings for a health check, Amazon // Route 53 associates the health check with all the records that you specify // in DnsConfig. // // A and AAAA records // // If DnsConfig includes configurations for both A and AAAA records, Route 53 // creates a health check that uses the IPv4 address to check the health of // the resource. If the endpoint that is specified by the IPv4 address is unhealthy, // Route 53 considers both the A and AAAA records to be unhealthy. // // CNAME records // // You can't specify settings for HealthCheckConfig when the DNSConfig includes // CNAME for the value of Type. If you do, the CreateService request will fail // with an InvalidInput error. // // Request interval // // The health check uses 30 seconds as the request interval. This is the number // of seconds between the time that each Route 53 health checker gets a response // from your endpoint and the time that it sends the next health check request. // A health checker in each data center around the world sends your endpoint // a health check request every 30 seconds. On average, your endpoint receives // a health check request about every two seconds. Health checkers in different // data centers don't coordinate with one another, so you'll sometimes see several // requests per second followed by a few seconds with no health checks at all. // // Health checking regions // // Health checkers perform checks from all Route 53 health-checking regions. // For a list of the current regions, see Regions (http://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions). // // Alias records // // When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, // Route 53 creates an alias record. Note the following: // // * Route 53 automatically sets EvaluateTargetHealth to true for alias records. // When EvaluateTargetHealth is true, the alias record inherits the health // of the referenced AWS resource. such as an ELB load balancer. For more // information, see EvaluateTargetHealth (http://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth). // // * If you include HealthCheckConfig and then use the service to register // an instance that creates an alias record, Route 53 doesn't create the // health check. // // For information about the charges for health checks, see Route 53 Pricing // (http://aws.amazon.com/route53/pricing). HealthCheckConfig *HealthCheckConfig `type:"structure"` // contains filtered or unexported fields }
A complex type that contains changes to an existing service. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ServiceChange
func (ServiceChange) GoString ¶
func (s ServiceChange) GoString() string
GoString returns the string representation
func (ServiceChange) String ¶
func (s ServiceChange) String() string
String returns the string representation
func (*ServiceChange) Validate ¶
func (s *ServiceChange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceDiscovery ¶
ServiceDiscovery provides the API operation methods for making requests to Amazon Route 53 Auto Naming. See this package's package overview docs for details on the service.
ServiceDiscovery methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(config aws.Config) *ServiceDiscovery
New creates a new instance of the ServiceDiscovery client with a config.
Example:
// Create a ServiceDiscovery client from just a config. svc := servicediscovery.New(myConfig)
func (*ServiceDiscovery) CreatePrivateDnsNamespaceRequest ¶
func (c *ServiceDiscovery) CreatePrivateDnsNamespaceRequest(input *CreatePrivateDnsNamespaceInput) CreatePrivateDnsNamespaceRequest
CreatePrivateDnsNamespaceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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.
// Example sending a request using the CreatePrivateDnsNamespaceRequest method. req := client.CreatePrivateDnsNamespaceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespace
func (*ServiceDiscovery) CreatePublicDnsNamespaceRequest ¶
func (c *ServiceDiscovery) CreatePublicDnsNamespaceRequest(input *CreatePublicDnsNamespaceInput) CreatePublicDnsNamespaceRequest
CreatePublicDnsNamespaceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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.
// Example sending a request using the CreatePublicDnsNamespaceRequest method. req := client.CreatePublicDnsNamespaceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespace
func (*ServiceDiscovery) CreateServiceRequest ¶
func (c *ServiceDiscovery) CreateServiceRequest(input *CreateServiceInput) CreateServiceRequest
CreateServiceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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.
// Example sending a request using the CreateServiceRequest method. req := client.CreateServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService
func (*ServiceDiscovery) DeleteNamespaceRequest ¶
func (c *ServiceDiscovery) DeleteNamespaceRequest(input *DeleteNamespaceInput) DeleteNamespaceRequest
DeleteNamespaceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
// Example sending a request using the DeleteNamespaceRequest method. req := client.DeleteNamespaceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespace
func (*ServiceDiscovery) DeleteServiceRequest ¶
func (c *ServiceDiscovery) DeleteServiceRequest(input *DeleteServiceInput) DeleteServiceRequest
DeleteServiceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
// Example sending a request using the DeleteServiceRequest method. req := client.DeleteServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService
func (*ServiceDiscovery) DeregisterInstanceRequest ¶
func (c *ServiceDiscovery) DeregisterInstanceRequest(input *DeregisterInstanceInput) DeregisterInstanceRequest
DeregisterInstanceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Deletes the records and the health check, if any, that Amazon Route 53 created for the specified instance.
// Example sending a request using the DeregisterInstanceRequest method. req := client.DeregisterInstanceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstance
func (*ServiceDiscovery) GetInstanceRequest ¶
func (c *ServiceDiscovery) GetInstanceRequest(input *GetInstanceInput) GetInstanceRequest
GetInstanceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Gets information about a specified instance.
// Example sending a request using the GetInstanceRequest method. req := client.GetInstanceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance
func (*ServiceDiscovery) GetInstancesHealthStatusRequest ¶
func (c *ServiceDiscovery) GetInstancesHealthStatusRequest(input *GetInstancesHealthStatusInput) GetInstancesHealthStatusRequest
GetInstancesHealthStatusRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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.
// Example sending a request using the GetInstancesHealthStatusRequest method. req := client.GetInstancesHealthStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatus
func (*ServiceDiscovery) GetNamespaceRequest ¶
func (c *ServiceDiscovery) GetNamespaceRequest(input *GetNamespaceInput) GetNamespaceRequest
GetNamespaceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Gets information about a namespace.
// Example sending a request using the GetNamespaceRequest method. req := client.GetNamespaceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespace
func (*ServiceDiscovery) GetOperationRequest ¶
func (c *ServiceDiscovery) GetOperationRequest(input *GetOperationInput) GetOperationRequest
GetOperationRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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.
// Example sending a request using the GetOperationRequest method. req := client.GetOperationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperation
func (*ServiceDiscovery) GetServiceRequest ¶
func (c *ServiceDiscovery) GetServiceRequest(input *GetServiceInput) GetServiceRequest
GetServiceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Gets the settings for a specified service.
// Example sending a request using the GetServiceRequest method. req := client.GetServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService
func (*ServiceDiscovery) ListInstancesRequest ¶
func (c *ServiceDiscovery) ListInstancesRequest(input *ListInstancesInput) ListInstancesRequest
ListInstancesRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Lists summary information about the instances that you registered by using a specified service.
// Example sending a request using the ListInstancesRequest method. req := client.ListInstancesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances
func (*ServiceDiscovery) ListNamespacesRequest ¶
func (c *ServiceDiscovery) ListNamespacesRequest(input *ListNamespacesInput) ListNamespacesRequest
ListNamespacesRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Lists summary information about the namespaces that were created by the current AWS account.
// Example sending a request using the ListNamespacesRequest method. req := client.ListNamespacesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespaces
func (*ServiceDiscovery) ListOperationsRequest ¶
func (c *ServiceDiscovery) ListOperationsRequest(input *ListOperationsInput) ListOperationsRequest
ListOperationsRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Lists operations that match the criteria that you specify.
// Example sending a request using the ListOperationsRequest method. req := client.ListOperationsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperations
func (*ServiceDiscovery) ListServicesRequest ¶
func (c *ServiceDiscovery) ListServicesRequest(input *ListServicesInput) ListServicesRequest
ListServicesRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
Lists summary information for all the services that are associated with one or more specified namespaces.
// Example sending a request using the ListServicesRequest method. req := client.ListServicesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices
func (*ServiceDiscovery) RegisterInstanceRequest ¶
func (c *ServiceDiscovery) RegisterInstanceRequest(input *RegisterInstanceInput) RegisterInstanceRequest
RegisterInstanceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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
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.
// Example sending a request using the RegisterInstanceRequest method. req := client.RegisterInstanceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstance
func (*ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest ¶ added in v0.4.0
func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest(input *UpdateInstanceCustomHealthStatusInput) UpdateInstanceCustomHealthStatusRequest
UpdateInstanceCustomHealthStatusRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
// Example sending a request using the UpdateInstanceCustomHealthStatusRequest method. req := client.UpdateInstanceCustomHealthStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatus
func (*ServiceDiscovery) UpdateServiceRequest ¶
func (c *ServiceDiscovery) UpdateServiceRequest(input *UpdateServiceInput) UpdateServiceRequest
UpdateServiceRequest returns a request value for making API operation for Amazon Route 53 Auto Naming.
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.
// Example sending a request using the UpdateServiceRequest method. req := client.UpdateServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateService
type ServiceFilter ¶
type ServiceFilter struct { // The operator that you want to use to determine whether a service is returned // by ListServices. Valid values for Condition include the following: // // * EQ: When you specify EQ, specify one namespace ID for Values. EQ is // the default condition and can be omitted. // // * IN: When you specify IN, specify a list of the IDs for the namespaces // that you want ListServices to return a list of services for. // // * BETWEEN: Not applicable. Condition FilterCondition `type:"string" enum:"true"` // Specify NAMESPACE_ID. // // Name is a required field Name ServiceFilterName `type:"string" required:"true" enum:"true"` // The values that are applicable to the value that you specify for Condition // to filter the list of services. // // Values is a required field Values []string `type:"list" required:"true"` // contains filtered or unexported fields }
A complex type that lets you specify the namespaces that you want to list services for. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ServiceFilter
func (ServiceFilter) GoString ¶
func (s ServiceFilter) GoString() string
GoString returns the string representation
func (ServiceFilter) String ¶
func (s ServiceFilter) String() string
String returns the string representation
func (*ServiceFilter) Validate ¶
func (s *ServiceFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceFilterName ¶
type ServiceFilterName string
const (
ServiceFilterNameNamespaceId ServiceFilterName = "NAMESPACE_ID"
)
Enum values for ServiceFilterName
func (ServiceFilterName) MarshalValue ¶ added in v0.3.0
func (enum ServiceFilterName) MarshalValue() (string, error)
func (ServiceFilterName) MarshalValueBuf ¶ added in v0.3.0
func (enum ServiceFilterName) MarshalValueBuf(b []byte) ([]byte, error)
type ServiceSummary ¶
type ServiceSummary struct { // The Amazon Resource Name (ARN) that Route 53 assigns to the service when // you create it. Arn *string `type:"string"` // The description that you specify when you create the service. Description *string `type:"string"` // The ID that Route 53 assigned to the service when you created it. Id *string `type:"string"` // The number of instances that are currently associated with the service. Instances // that were previously associated with the service but that have been deleted // are not included in the count. InstanceCount *int64 `type:"integer"` // The name of the service. Name *string `type:"string"` // contains filtered or unexported fields }
A complex type that contains information about a specified service. Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ServiceSummary
func (ServiceSummary) GoString ¶
func (s ServiceSummary) GoString() string
GoString returns the string representation
func (ServiceSummary) String ¶
func (s ServiceSummary) String() string
String returns the string representation
type UpdateInstanceCustomHealthStatusInput ¶ added in v0.4.0
type UpdateInstanceCustomHealthStatusInput struct { // InstanceId is a required field InstanceId *string `type:"string" required:"true"` // ServiceId is a required field ServiceId *string `type:"string" required:"true"` // Status is a required field Status CustomHealthStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatusRequest
func (UpdateInstanceCustomHealthStatusInput) GoString ¶ added in v0.4.0
func (s UpdateInstanceCustomHealthStatusInput) GoString() string
GoString returns the string representation
func (UpdateInstanceCustomHealthStatusInput) String ¶ added in v0.4.0
func (s UpdateInstanceCustomHealthStatusInput) String() string
String returns the string representation
func (*UpdateInstanceCustomHealthStatusInput) Validate ¶ added in v0.4.0
func (s *UpdateInstanceCustomHealthStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateInstanceCustomHealthStatusOutput ¶ added in v0.4.0
type UpdateInstanceCustomHealthStatusOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatusOutput
func (UpdateInstanceCustomHealthStatusOutput) GoString ¶ added in v0.4.0
func (s UpdateInstanceCustomHealthStatusOutput) GoString() string
GoString returns the string representation
func (UpdateInstanceCustomHealthStatusOutput) SDKResponseMetadata ¶ added in v0.4.0
func (s UpdateInstanceCustomHealthStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateInstanceCustomHealthStatusOutput) String ¶ added in v0.4.0
func (s UpdateInstanceCustomHealthStatusOutput) String() string
String returns the string representation
type UpdateInstanceCustomHealthStatusRequest ¶ added in v0.4.0
type UpdateInstanceCustomHealthStatusRequest struct { *aws.Request Input *UpdateInstanceCustomHealthStatusInput Copy func(*UpdateInstanceCustomHealthStatusInput) UpdateInstanceCustomHealthStatusRequest }
UpdateInstanceCustomHealthStatusRequest is a API request type for the UpdateInstanceCustomHealthStatus API operation.
func (UpdateInstanceCustomHealthStatusRequest) Send ¶ added in v0.4.0
func (r UpdateInstanceCustomHealthStatusRequest) Send() (*UpdateInstanceCustomHealthStatusOutput, error)
Send marshals and sends the UpdateInstanceCustomHealthStatus API request.
type UpdateServiceInput ¶
type UpdateServiceInput struct { // The ID of the service that you want to update. // // Id is a required field Id *string `type:"string" required:"true"` // A complex type that contains the new settings for the service. // // Service is a required field Service *ServiceChange `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateServiceRequest
func (UpdateServiceInput) GoString ¶
func (s UpdateServiceInput) GoString() string
GoString returns the string representation
func (UpdateServiceInput) String ¶
func (s UpdateServiceInput) String() string
String returns the string representation
func (*UpdateServiceInput) Validate ¶
func (s *UpdateServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateServiceOutput ¶
type UpdateServiceOutput struct { // A value that you can use to determine whether the request completed successfully. // To get the status of the operation, see GetOperation. OperationId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateServiceResponse
func (UpdateServiceOutput) GoString ¶
func (s UpdateServiceOutput) GoString() string
GoString returns the string representation
func (UpdateServiceOutput) SDKResponseMetadata ¶
func (s UpdateServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateServiceOutput) String ¶
func (s UpdateServiceOutput) String() string
String returns the string representation
type UpdateServiceRequest ¶
type UpdateServiceRequest struct { *aws.Request Input *UpdateServiceInput Copy func(*UpdateServiceInput) UpdateServiceRequest }
UpdateServiceRequest is a API request type for the UpdateService API operation.
func (UpdateServiceRequest) Send ¶
func (r UpdateServiceRequest) Send() (*UpdateServiceOutput, error)
Send marshals and sends the UpdateService API request.
Directories ¶
Path | Synopsis |
---|---|
Package servicediscoveryiface provides an interface to enable mocking the Amazon Route 53 Auto Naming service client for testing your code.
|
Package servicediscoveryiface provides an interface to enable mocking the Amazon Route 53 Auto Naming service client for testing your code. |