aws-sdk-go: github.com/aws/aws-sdk-go/service/servicediscovery Index | Files | Directories

package servicediscovery

import "github.com/aws/aws-sdk-go/service/servicediscovery"

Package servicediscovery provides the client and types for making API requests to AWS Cloud Map.

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

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 contact AWS Cloud Map 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 AWS Cloud Map client ServiceDiscovery for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/servicediscovery/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // CustomHealthStatusHealthy is a CustomHealthStatus enum value
    CustomHealthStatusHealthy = "HEALTHY"

    // CustomHealthStatusUnhealthy is a CustomHealthStatus enum value
    CustomHealthStatusUnhealthy = "UNHEALTHY"
)
const (
    // FilterConditionEq is a FilterCondition enum value
    FilterConditionEq = "EQ"

    // FilterConditionIn is a FilterCondition enum value
    FilterConditionIn = "IN"

    // FilterConditionBetween is a FilterCondition enum value
    FilterConditionBetween = "BETWEEN"
)
const (
    // HealthCheckTypeHttp is a HealthCheckType enum value
    HealthCheckTypeHttp = "HTTP"

    // HealthCheckTypeHttps is a HealthCheckType enum value
    HealthCheckTypeHttps = "HTTPS"

    // HealthCheckTypeTcp is a HealthCheckType enum value
    HealthCheckTypeTcp = "TCP"
)
const (
    // HealthStatusHealthy is a HealthStatus enum value
    HealthStatusHealthy = "HEALTHY"

    // HealthStatusUnhealthy is a HealthStatus enum value
    HealthStatusUnhealthy = "UNHEALTHY"

    // HealthStatusUnknown is a HealthStatus enum value
    HealthStatusUnknown = "UNKNOWN"
)
const (
    // HealthStatusFilterHealthy is a HealthStatusFilter enum value
    HealthStatusFilterHealthy = "HEALTHY"

    // HealthStatusFilterUnhealthy is a HealthStatusFilter enum value
    HealthStatusFilterUnhealthy = "UNHEALTHY"

    // HealthStatusFilterAll is a HealthStatusFilter enum value
    HealthStatusFilterAll = "ALL"
)
const (
    // NamespaceTypeDnsPublic is a NamespaceType enum value
    NamespaceTypeDnsPublic = "DNS_PUBLIC"

    // NamespaceTypeDnsPrivate is a NamespaceType enum value
    NamespaceTypeDnsPrivate = "DNS_PRIVATE"

    // NamespaceTypeHttp is a NamespaceType enum value
    NamespaceTypeHttp = "HTTP"
)
const (
    // OperationFilterNameNamespaceId is a OperationFilterName enum value
    OperationFilterNameNamespaceId = "NAMESPACE_ID"

    // OperationFilterNameServiceId is a OperationFilterName enum value
    OperationFilterNameServiceId = "SERVICE_ID"

    // OperationFilterNameStatus is a OperationFilterName enum value
    OperationFilterNameStatus = "STATUS"

    // OperationFilterNameType is a OperationFilterName enum value
    OperationFilterNameType = "TYPE"

    // OperationFilterNameUpdateDate is a OperationFilterName enum value
    OperationFilterNameUpdateDate = "UPDATE_DATE"
)
const (
    // OperationStatusSubmitted is a OperationStatus enum value
    OperationStatusSubmitted = "SUBMITTED"

    // OperationStatusPending is a OperationStatus enum value
    OperationStatusPending = "PENDING"

    // OperationStatusSuccess is a OperationStatus enum value
    OperationStatusSuccess = "SUCCESS"

    // OperationStatusFail is a OperationStatus enum value
    OperationStatusFail = "FAIL"
)
const (
    // OperationTargetTypeNamespace is a OperationTargetType enum value
    OperationTargetTypeNamespace = "NAMESPACE"

    // OperationTargetTypeService is a OperationTargetType enum value
    OperationTargetTypeService = "SERVICE"

    // OperationTargetTypeInstance is a OperationTargetType enum value
    OperationTargetTypeInstance = "INSTANCE"
)
const (
    // OperationTypeCreateNamespace is a OperationType enum value
    OperationTypeCreateNamespace = "CREATE_NAMESPACE"

    // OperationTypeDeleteNamespace is a OperationType enum value
    OperationTypeDeleteNamespace = "DELETE_NAMESPACE"

    // OperationTypeUpdateService is a OperationType enum value
    OperationTypeUpdateService = "UPDATE_SERVICE"

    // OperationTypeRegisterInstance is a OperationType enum value
    OperationTypeRegisterInstance = "REGISTER_INSTANCE"

    // OperationTypeDeregisterInstance is a OperationType enum value
    OperationTypeDeregisterInstance = "DEREGISTER_INSTANCE"
)
const (
    // RecordTypeSrv is a RecordType enum value
    RecordTypeSrv = "SRV"

    // RecordTypeA is a RecordType enum value
    RecordTypeA = "A"

    // RecordTypeAaaa is a RecordType enum value
    RecordTypeAaaa = "AAAA"

    // RecordTypeCname is a RecordType enum value
    RecordTypeCname = "CNAME"
)
const (
    // RoutingPolicyMultivalue is a RoutingPolicy enum value
    RoutingPolicyMultivalue = "MULTIVALUE"

    // RoutingPolicyWeighted is a RoutingPolicy enum value
    RoutingPolicyWeighted = "WEIGHTED"
)
const (

    // ErrCodeCustomHealthNotFound for service response error code
    // "CustomHealthNotFound".
    //
    // The health check for the instance that is specified by ServiceId and InstanceId
    // is not a custom health check.
    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, a required value
    // might be missing, a numeric value might be outside the allowed range, or
    // a string value might exceed length constraints.
    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" // Name of service.
    EndpointsID = ServiceName        // ID to lookup a service endpoint with.
    ServiceID   = "ServiceDiscovery" // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // NamespaceFilterNameType is a NamespaceFilterName enum value
    NamespaceFilterNameType = "TYPE"
)
const (
    // ServiceFilterNameNamespaceId is a ServiceFilterName enum value
    ServiceFilterNameNamespaceId = "NAMESPACE_ID"
)

type CreateHttpNamespaceInput Uses

type CreateHttpNamespaceInput struct {

    // A unique string that identifies the request and that allows failed CreateHttpNamespace
    // 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
}

func (CreateHttpNamespaceInput) GoString Uses

func (s CreateHttpNamespaceInput) GoString() string

GoString returns the string representation

func (*CreateHttpNamespaceInput) SetCreatorRequestId Uses

func (s *CreateHttpNamespaceInput) SetCreatorRequestId(v string) *CreateHttpNamespaceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreateHttpNamespaceInput) SetDescription Uses

func (s *CreateHttpNamespaceInput) SetDescription(v string) *CreateHttpNamespaceInput

SetDescription sets the Description field's value.

func (*CreateHttpNamespaceInput) SetName Uses

func (s *CreateHttpNamespaceInput) SetName(v string) *CreateHttpNamespaceInput

SetName sets the Name field's value.

func (CreateHttpNamespaceInput) String Uses

func (s CreateHttpNamespaceInput) String() string

String returns the string representation

func (*CreateHttpNamespaceInput) Validate Uses

func (s *CreateHttpNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateHttpNamespaceOutput Uses

type CreateHttpNamespaceOutput 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
}

func (CreateHttpNamespaceOutput) GoString Uses

func (s CreateHttpNamespaceOutput) GoString() string

GoString returns the string representation

func (*CreateHttpNamespaceOutput) SetOperationId Uses

func (s *CreateHttpNamespaceOutput) SetOperationId(v string) *CreateHttpNamespaceOutput

SetOperationId sets the OperationId field's value.

func (CreateHttpNamespaceOutput) String Uses

func (s CreateHttpNamespaceOutput) String() string

String returns the string representation

type CreatePrivateDnsNamespaceInput Uses

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 private
    // DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private
    // 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
}

func (CreatePrivateDnsNamespaceInput) GoString Uses

func (s CreatePrivateDnsNamespaceInput) GoString() string

GoString returns the string representation

func (*CreatePrivateDnsNamespaceInput) SetCreatorRequestId Uses

func (s *CreatePrivateDnsNamespaceInput) SetCreatorRequestId(v string) *CreatePrivateDnsNamespaceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreatePrivateDnsNamespaceInput) SetDescription Uses

func (s *CreatePrivateDnsNamespaceInput) SetDescription(v string) *CreatePrivateDnsNamespaceInput

SetDescription sets the Description field's value.

func (*CreatePrivateDnsNamespaceInput) SetName Uses

func (s *CreatePrivateDnsNamespaceInput) SetName(v string) *CreatePrivateDnsNamespaceInput

SetName sets the Name field's value.

func (*CreatePrivateDnsNamespaceInput) SetVpc Uses

func (s *CreatePrivateDnsNamespaceInput) SetVpc(v string) *CreatePrivateDnsNamespaceInput

SetVpc sets the Vpc field's value.

func (CreatePrivateDnsNamespaceInput) String Uses

func (s CreatePrivateDnsNamespaceInput) String() string

String returns the string representation

func (*CreatePrivateDnsNamespaceInput) Validate Uses

func (s *CreatePrivateDnsNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePrivateDnsNamespaceOutput Uses

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
}

func (CreatePrivateDnsNamespaceOutput) GoString Uses

func (s CreatePrivateDnsNamespaceOutput) GoString() string

GoString returns the string representation

func (*CreatePrivateDnsNamespaceOutput) SetOperationId Uses

func (s *CreatePrivateDnsNamespaceOutput) SetOperationId(v string) *CreatePrivateDnsNamespaceOutput

SetOperationId sets the OperationId field's value.

func (CreatePrivateDnsNamespaceOutput) String Uses

func (s CreatePrivateDnsNamespaceOutput) String() string

String returns the string representation

type CreatePublicDnsNamespaceInput Uses

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
}

func (CreatePublicDnsNamespaceInput) GoString Uses

func (s CreatePublicDnsNamespaceInput) GoString() string

GoString returns the string representation

func (*CreatePublicDnsNamespaceInput) SetCreatorRequestId Uses

func (s *CreatePublicDnsNamespaceInput) SetCreatorRequestId(v string) *CreatePublicDnsNamespaceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreatePublicDnsNamespaceInput) SetDescription Uses

func (s *CreatePublicDnsNamespaceInput) SetDescription(v string) *CreatePublicDnsNamespaceInput

SetDescription sets the Description field's value.

func (*CreatePublicDnsNamespaceInput) SetName Uses

func (s *CreatePublicDnsNamespaceInput) SetName(v string) *CreatePublicDnsNamespaceInput

SetName sets the Name field's value.

func (CreatePublicDnsNamespaceInput) String Uses

func (s CreatePublicDnsNamespaceInput) String() string

String returns the string representation

func (*CreatePublicDnsNamespaceInput) Validate Uses

func (s *CreatePublicDnsNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePublicDnsNamespaceOutput Uses

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
}

func (CreatePublicDnsNamespaceOutput) GoString Uses

func (s CreatePublicDnsNamespaceOutput) GoString() string

GoString returns the string representation

func (*CreatePublicDnsNamespaceOutput) SetOperationId Uses

func (s *CreatePublicDnsNamespaceOutput) SetOperationId(v string) *CreatePublicDnsNamespaceOutput

SetOperationId sets the OperationId field's value.

func (CreatePublicDnsNamespaceOutput) String Uses

func (s CreatePublicDnsNamespaceOutput) String() string

String returns the string representation

type CreateServiceInput Uses

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 Amazon Route 53 records
    // that you want AWS Cloud Map to create when you register an instance.
    DnsConfig *DnsConfig `type:"structure"`

    // Public DNS namespaces only. A complex type that contains settings for an
    // optional Route 53 health check. If you specify settings for a health check,
    // AWS Cloud Map associates the health check with all the Route 53 DNS records
    // that you specify in DnsConfig.
    //
    // If you specify a health check configuration, you can specify either HealthCheckCustomConfig
    // or HealthCheckConfig but not both.
    //
    // For information about the charges for health checks, see AWS Cloud Map Pricing
    // (http://aws.amazon.com/cloud-map/pricing/).
    HealthCheckConfig *HealthCheckConfig `type:"structure"`

    // A complex type that contains information about an optional custom health
    // check.
    //
    // If you specify a health check configuration, you can specify either HealthCheckCustomConfig
    // or HealthCheckConfig but not both.
    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"`

    // The ID of the namespace that you want to use to create the service.
    NamespaceId *string `type:"string"`
    // contains filtered or unexported fields
}

func (CreateServiceInput) GoString Uses

func (s CreateServiceInput) GoString() string

GoString returns the string representation

func (*CreateServiceInput) SetCreatorRequestId Uses

func (s *CreateServiceInput) SetCreatorRequestId(v string) *CreateServiceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreateServiceInput) SetDescription Uses

func (s *CreateServiceInput) SetDescription(v string) *CreateServiceInput

SetDescription sets the Description field's value.

func (*CreateServiceInput) SetDnsConfig Uses

func (s *CreateServiceInput) SetDnsConfig(v *DnsConfig) *CreateServiceInput

SetDnsConfig sets the DnsConfig field's value.

func (*CreateServiceInput) SetHealthCheckConfig Uses

func (s *CreateServiceInput) SetHealthCheckConfig(v *HealthCheckConfig) *CreateServiceInput

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (*CreateServiceInput) SetHealthCheckCustomConfig Uses

func (s *CreateServiceInput) SetHealthCheckCustomConfig(v *HealthCheckCustomConfig) *CreateServiceInput

SetHealthCheckCustomConfig sets the HealthCheckCustomConfig field's value.

func (*CreateServiceInput) SetName Uses

func (s *CreateServiceInput) SetName(v string) *CreateServiceInput

SetName sets the Name field's value.

func (*CreateServiceInput) SetNamespaceId Uses

func (s *CreateServiceInput) SetNamespaceId(v string) *CreateServiceInput

SetNamespaceId sets the NamespaceId field's value.

func (CreateServiceInput) String Uses

func (s CreateServiceInput) String() string

String returns the string representation

func (*CreateServiceInput) Validate Uses

func (s *CreateServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateServiceOutput Uses

type CreateServiceOutput struct {

    // A complex type that contains information about the new service.
    Service *Service `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateServiceOutput) GoString Uses

func (s CreateServiceOutput) GoString() string

GoString returns the string representation

func (*CreateServiceOutput) SetService Uses

func (s *CreateServiceOutput) SetService(v *Service) *CreateServiceOutput

SetService sets the Service field's value.

func (CreateServiceOutput) String Uses

func (s CreateServiceOutput) String() string

String returns the string representation

type DeleteNamespaceInput Uses

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
}

func (DeleteNamespaceInput) GoString Uses

func (s DeleteNamespaceInput) GoString() string

GoString returns the string representation

func (*DeleteNamespaceInput) SetId Uses

func (s *DeleteNamespaceInput) SetId(v string) *DeleteNamespaceInput

SetId sets the Id field's value.

func (DeleteNamespaceInput) String Uses

func (s DeleteNamespaceInput) String() string

String returns the string representation

func (*DeleteNamespaceInput) Validate Uses

func (s *DeleteNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteNamespaceOutput Uses

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
}

func (DeleteNamespaceOutput) GoString Uses

func (s DeleteNamespaceOutput) GoString() string

GoString returns the string representation

func (*DeleteNamespaceOutput) SetOperationId Uses

func (s *DeleteNamespaceOutput) SetOperationId(v string) *DeleteNamespaceOutput

SetOperationId sets the OperationId field's value.

func (DeleteNamespaceOutput) String Uses

func (s DeleteNamespaceOutput) String() string

String returns the string representation

type DeleteServiceInput Uses

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
}

func (DeleteServiceInput) GoString Uses

func (s DeleteServiceInput) GoString() string

GoString returns the string representation

func (*DeleteServiceInput) SetId Uses

func (s *DeleteServiceInput) SetId(v string) *DeleteServiceInput

SetId sets the Id field's value.

func (DeleteServiceInput) String Uses

func (s DeleteServiceInput) String() string

String returns the string representation

func (*DeleteServiceInput) Validate Uses

func (s *DeleteServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteServiceOutput Uses

type DeleteServiceOutput struct {
    // contains filtered or unexported fields
}

func (DeleteServiceOutput) GoString Uses

func (s DeleteServiceOutput) GoString() string

GoString returns the string representation

func (DeleteServiceOutput) String Uses

func (s DeleteServiceOutput) String() string

String returns the string representation

type DeregisterInstanceInput Uses

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
}

func (DeregisterInstanceInput) GoString Uses

func (s DeregisterInstanceInput) GoString() string

GoString returns the string representation

func (*DeregisterInstanceInput) SetInstanceId Uses

func (s *DeregisterInstanceInput) SetInstanceId(v string) *DeregisterInstanceInput

SetInstanceId sets the InstanceId field's value.

func (*DeregisterInstanceInput) SetServiceId Uses

func (s *DeregisterInstanceInput) SetServiceId(v string) *DeregisterInstanceInput

SetServiceId sets the ServiceId field's value.

func (DeregisterInstanceInput) String Uses

func (s DeregisterInstanceInput) String() string

String returns the string representation

func (*DeregisterInstanceInput) Validate Uses

func (s *DeregisterInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterInstanceOutput Uses

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
}

func (DeregisterInstanceOutput) GoString Uses

func (s DeregisterInstanceOutput) GoString() string

GoString returns the string representation

func (*DeregisterInstanceOutput) SetOperationId Uses

func (s *DeregisterInstanceOutput) SetOperationId(v string) *DeregisterInstanceOutput

SetOperationId sets the OperationId field's value.

func (DeregisterInstanceOutput) String Uses

func (s DeregisterInstanceOutput) String() string

String returns the string representation

type DiscoverInstancesInput Uses

type DiscoverInstancesInput struct {

    // The health status of the instances that you want to discover.
    HealthStatus *string `type:"string" enum:"HealthStatusFilter"`

    // The maximum number of instances that you want Cloud Map to return in the
    // response to a DiscoverInstances request. If you don't specify a value for
    // MaxResults, Cloud Map returns up to 100 instances.
    MaxResults *int64 `min:"1" type:"integer"`

    // The name of the namespace that you specified when you registered the instance.
    //
    // NamespaceName is a required field
    NamespaceName *string `type:"string" required:"true"`

    // A string map that contains attributes with values that you can use to filter
    // instances by any custom attribute that you specified when you registered
    // the instance. Only instances that match all the specified key/value pairs
    // will be returned.
    QueryParameters map[string]*string `type:"map"`

    // The name of the service that you specified when you registered the instance.
    //
    // ServiceName is a required field
    ServiceName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DiscoverInstancesInput) GoString Uses

func (s DiscoverInstancesInput) GoString() string

GoString returns the string representation

func (*DiscoverInstancesInput) SetHealthStatus Uses

func (s *DiscoverInstancesInput) SetHealthStatus(v string) *DiscoverInstancesInput

SetHealthStatus sets the HealthStatus field's value.

func (*DiscoverInstancesInput) SetMaxResults Uses

func (s *DiscoverInstancesInput) SetMaxResults(v int64) *DiscoverInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*DiscoverInstancesInput) SetNamespaceName Uses

func (s *DiscoverInstancesInput) SetNamespaceName(v string) *DiscoverInstancesInput

SetNamespaceName sets the NamespaceName field's value.

func (*DiscoverInstancesInput) SetQueryParameters Uses

func (s *DiscoverInstancesInput) SetQueryParameters(v map[string]*string) *DiscoverInstancesInput

SetQueryParameters sets the QueryParameters field's value.

func (*DiscoverInstancesInput) SetServiceName Uses

func (s *DiscoverInstancesInput) SetServiceName(v string) *DiscoverInstancesInput

SetServiceName sets the ServiceName field's value.

func (DiscoverInstancesInput) String Uses

func (s DiscoverInstancesInput) String() string

String returns the string representation

func (*DiscoverInstancesInput) Validate Uses

func (s *DiscoverInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DiscoverInstancesOutput Uses

type DiscoverInstancesOutput struct {

    // A complex type that contains one HttpInstanceSummary for each registered
    // instance.
    Instances []*HttpInstanceSummary `type:"list"`
    // contains filtered or unexported fields
}

func (DiscoverInstancesOutput) GoString Uses

func (s DiscoverInstancesOutput) GoString() string

GoString returns the string representation

func (*DiscoverInstancesOutput) SetInstances Uses

func (s *DiscoverInstancesOutput) SetInstances(v []*HttpInstanceSummary) *DiscoverInstancesOutput

SetInstances sets the Instances field's value.

func (DiscoverInstancesOutput) String Uses

func (s DiscoverInstancesOutput) String() string

String returns the string representation

type DnsConfig Uses

type DnsConfig struct {

    // An array that contains one DnsRecord object for each Route 53 DNS record
    // that you want AWS Cloud Map 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.
    //
    // Deprecated: Top level attribute in request should be used to reference namespace-id
    NamespaceId *string `deprecated:"true" type:"string"`

    // The routing policy that you want to apply to all Route 53 DNS records that
    // AWS Cloud Map 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 *string `type:"string" enum:"RoutingPolicy"`
    // contains filtered or unexported fields
}

A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

func (DnsConfig) GoString Uses

func (s DnsConfig) GoString() string

GoString returns the string representation

func (*DnsConfig) SetDnsRecords Uses

func (s *DnsConfig) SetDnsRecords(v []*DnsRecord) *DnsConfig

SetDnsRecords sets the DnsRecords field's value.

func (*DnsConfig) SetNamespaceId Uses

func (s *DnsConfig) SetNamespaceId(v string) *DnsConfig

SetNamespaceId sets the NamespaceId field's value.

func (*DnsConfig) SetRoutingPolicy Uses

func (s *DnsConfig) SetRoutingPolicy(v string) *DnsConfig

SetRoutingPolicy sets the RoutingPolicy field's value.

func (DnsConfig) String Uses

func (s DnsConfig) String() string

String returns the string representation

func (*DnsConfig) Validate Uses

func (s *DnsConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DnsConfigChange Uses

type DnsConfigChange struct {

    // An array that contains one DnsRecord object for each Route 53 record that
    // you want AWS Cloud Map 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 Route 53 DNS records that AWS Cloud Map creates when you register an instance.

func (DnsConfigChange) GoString Uses

func (s DnsConfigChange) GoString() string

GoString returns the string representation

func (*DnsConfigChange) SetDnsRecords Uses

func (s *DnsConfigChange) SetDnsRecords(v []*DnsRecord) *DnsConfigChange

SetDnsRecords sets the DnsRecords field's value.

func (DnsConfigChange) String Uses

func (s DnsConfigChange) String() string

String returns the string representation

func (*DnsConfigChange) Validate Uses

func (s *DnsConfigChange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DnsProperties Uses

type DnsProperties struct {

    // The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create
    // a namespace.
    HostedZoneId *string `type:"string"`
    // contains filtered or unexported fields
}

A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

func (DnsProperties) GoString Uses

func (s DnsProperties) GoString() string

GoString returns the string representation

func (*DnsProperties) SetHostedZoneId Uses

func (s *DnsProperties) SetHostedZoneId(v string) *DnsProperties

SetHostedZoneId sets the HostedZoneId field's value.

func (DnsProperties) String Uses

func (s DnsProperties) String() string

String returns the string representation

type DnsRecord Uses

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 AWS Cloud Map to create a Route 53 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, AWS Cloud Map
    // 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 *string `type:"string" required:"true" enum:"RecordType"`
    // contains filtered or unexported fields
}

A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

func (DnsRecord) GoString Uses

func (s DnsRecord) GoString() string

GoString returns the string representation

func (*DnsRecord) SetTTL Uses

func (s *DnsRecord) SetTTL(v int64) *DnsRecord

SetTTL sets the TTL field's value.

func (*DnsRecord) SetType Uses

func (s *DnsRecord) SetType(v string) *DnsRecord

SetType sets the Type field's value.

func (DnsRecord) String Uses

func (s DnsRecord) String() string

String returns the string representation

func (*DnsRecord) Validate Uses

func (s *DnsRecord) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceInput Uses

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
}

func (GetInstanceInput) GoString Uses

func (s GetInstanceInput) GoString() string

GoString returns the string representation

func (*GetInstanceInput) SetInstanceId Uses

func (s *GetInstanceInput) SetInstanceId(v string) *GetInstanceInput

SetInstanceId sets the InstanceId field's value.

func (*GetInstanceInput) SetServiceId Uses

func (s *GetInstanceInput) SetServiceId(v string) *GetInstanceInput

SetServiceId sets the ServiceId field's value.

func (GetInstanceInput) String Uses

func (s GetInstanceInput) String() string

String returns the string representation

func (*GetInstanceInput) Validate Uses

func (s *GetInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceOutput Uses

type GetInstanceOutput struct {

    // A complex type that contains information about a specified instance.
    Instance *Instance `type:"structure"`
    // contains filtered or unexported fields
}

func (GetInstanceOutput) GoString Uses

func (s GetInstanceOutput) GoString() string

GoString returns the string representation

func (*GetInstanceOutput) SetInstance Uses

func (s *GetInstanceOutput) SetInstance(v *Instance) *GetInstanceOutput

SetInstance sets the Instance field's value.

func (GetInstanceOutput) String Uses

func (s GetInstanceOutput) String() string

String returns the string representation

type GetInstancesHealthStatusInput Uses

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, AWS Cloud Map 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 AWS Cloud Map to return in
    // the response to a GetInstancesHealthStatus request. If you don't specify
    // a value for MaxResults, AWS Cloud Map 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
}

func (GetInstancesHealthStatusInput) GoString Uses

func (s GetInstancesHealthStatusInput) GoString() string

GoString returns the string representation

func (*GetInstancesHealthStatusInput) SetInstances Uses

func (s *GetInstancesHealthStatusInput) SetInstances(v []*string) *GetInstancesHealthStatusInput

SetInstances sets the Instances field's value.

func (*GetInstancesHealthStatusInput) SetMaxResults Uses

func (s *GetInstancesHealthStatusInput) SetMaxResults(v int64) *GetInstancesHealthStatusInput

SetMaxResults sets the MaxResults field's value.

func (*GetInstancesHealthStatusInput) SetNextToken Uses

func (s *GetInstancesHealthStatusInput) SetNextToken(v string) *GetInstancesHealthStatusInput

SetNextToken sets the NextToken field's value.

func (*GetInstancesHealthStatusInput) SetServiceId Uses

func (s *GetInstancesHealthStatusInput) SetServiceId(v string) *GetInstancesHealthStatusInput

SetServiceId sets the ServiceId field's value.

func (GetInstancesHealthStatusInput) String Uses

func (s GetInstancesHealthStatusInput) String() string

String returns the string representation

func (*GetInstancesHealthStatusInput) Validate Uses

func (s *GetInstancesHealthStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstancesHealthStatusOutput Uses

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]*string `type:"map"`
    // contains filtered or unexported fields
}

func (GetInstancesHealthStatusOutput) GoString Uses

func (s GetInstancesHealthStatusOutput) GoString() string

GoString returns the string representation

func (*GetInstancesHealthStatusOutput) SetNextToken Uses

func (s *GetInstancesHealthStatusOutput) SetNextToken(v string) *GetInstancesHealthStatusOutput

SetNextToken sets the NextToken field's value.

func (*GetInstancesHealthStatusOutput) SetStatus Uses

func (s *GetInstancesHealthStatusOutput) SetStatus(v map[string]*string) *GetInstancesHealthStatusOutput

SetStatus sets the Status field's value.

func (GetInstancesHealthStatusOutput) String Uses

func (s GetInstancesHealthStatusOutput) String() string

String returns the string representation

type GetNamespaceInput Uses

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
}

func (GetNamespaceInput) GoString Uses

func (s GetNamespaceInput) GoString() string

GoString returns the string representation

func (*GetNamespaceInput) SetId Uses

func (s *GetNamespaceInput) SetId(v string) *GetNamespaceInput

SetId sets the Id field's value.

func (GetNamespaceInput) String Uses

func (s GetNamespaceInput) String() string

String returns the string representation

func (*GetNamespaceInput) Validate Uses

func (s *GetNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetNamespaceOutput Uses

type GetNamespaceOutput struct {

    // A complex type that contains information about the specified namespace.
    Namespace *Namespace `type:"structure"`
    // contains filtered or unexported fields
}

func (GetNamespaceOutput) GoString Uses

func (s GetNamespaceOutput) GoString() string

GoString returns the string representation

func (*GetNamespaceOutput) SetNamespace Uses

func (s *GetNamespaceOutput) SetNamespace(v *Namespace) *GetNamespaceOutput

SetNamespace sets the Namespace field's value.

func (GetNamespaceOutput) String Uses

func (s GetNamespaceOutput) String() string

String returns the string representation

type GetOperationInput Uses

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
}

func (GetOperationInput) GoString Uses

func (s GetOperationInput) GoString() string

GoString returns the string representation

func (*GetOperationInput) SetOperationId Uses

func (s *GetOperationInput) SetOperationId(v string) *GetOperationInput

SetOperationId sets the OperationId field's value.

func (GetOperationInput) String Uses

func (s GetOperationInput) String() string

String returns the string representation

func (*GetOperationInput) Validate Uses

func (s *GetOperationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOperationOutput Uses

type GetOperationOutput struct {

    // A complex type that contains information about the operation.
    Operation *Operation `type:"structure"`
    // contains filtered or unexported fields
}

func (GetOperationOutput) GoString Uses

func (s GetOperationOutput) GoString() string

GoString returns the string representation

func (*GetOperationOutput) SetOperation Uses

func (s *GetOperationOutput) SetOperation(v *Operation) *GetOperationOutput

SetOperation sets the Operation field's value.

func (GetOperationOutput) String Uses

func (s GetOperationOutput) String() string

String returns the string representation

type GetServiceInput Uses

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
}

func (GetServiceInput) GoString Uses

func (s GetServiceInput) GoString() string

GoString returns the string representation

func (*GetServiceInput) SetId Uses

func (s *GetServiceInput) SetId(v string) *GetServiceInput

SetId sets the Id field's value.

func (GetServiceInput) String Uses

func (s GetServiceInput) String() string

String returns the string representation

func (*GetServiceInput) Validate Uses

func (s *GetServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetServiceOutput Uses

type GetServiceOutput struct {

    // A complex type that contains information about the service.
    Service *Service `type:"structure"`
    // contains filtered or unexported fields
}

func (GetServiceOutput) GoString Uses

func (s GetServiceOutput) GoString() string

GoString returns the string representation

func (*GetServiceOutput) SetService Uses

func (s *GetServiceOutput) SetService(v *Service) *GetServiceOutput

SetService sets the Service field's value.

func (GetServiceOutput) String Uses

func (s GetServiceOutput) String() string

String returns the string representation

type HealthCheckConfig Uses

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. If you don't specify
    // a value for ResourcePath, the default value is /.
    //
    // If you specify TCP for Type, you must not specify a value for ResourcePath.
    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. If you specify TCP
    //    for Type, don't specify a value for ResourcePath.
    //
    // 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 is a required field
    Type *string `type:"string" required:"true" enum:"HealthCheckType"`
    // 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, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/).

Note the following about configuring health checks.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map 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

A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers 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, AWS Cloud Map creates a Route 53 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.

Charges for health checks

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/).

func (HealthCheckConfig) GoString Uses

func (s HealthCheckConfig) GoString() string

GoString returns the string representation

func (*HealthCheckConfig) SetFailureThreshold Uses

func (s *HealthCheckConfig) SetFailureThreshold(v int64) *HealthCheckConfig

SetFailureThreshold sets the FailureThreshold field's value.

func (*HealthCheckConfig) SetResourcePath Uses

func (s *HealthCheckConfig) SetResourcePath(v string) *HealthCheckConfig

SetResourcePath sets the ResourcePath field's value.

func (*HealthCheckConfig) SetType Uses

func (s *HealthCheckConfig) SetType(v string) *HealthCheckConfig

SetType sets the Type field's value.

func (HealthCheckConfig) String Uses

func (s HealthCheckConfig) String() string

String returns the string representation

func (*HealthCheckConfig) Validate Uses

func (s *HealthCheckConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HealthCheckCustomConfig Uses

type HealthCheckCustomConfig struct {

    // The number of 30-second intervals that you want Cloud Map to wait after receiving
    // an UpdateInstanceCustomHealthStatus request before it changes the health
    // status of a service instance. For example, suppose you specify a value of
    // 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus
    // request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing
    // the status of the service instance based on that request.
    //
    // Sending a second or subsequent UpdateInstanceCustomHealthStatus request with
    // the same value before FailureThreshold x 30 seconds has passed doesn't accelerate
    // the change. Cloud Map still waits FailureThreshold x 30 seconds after the
    // first request to make the change.
    FailureThreshold *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

* You can't use a health check that is defined by HealthCheckConfig because
the resource isn't available over the internet. For example, you can use
a custom health check when the instance is in an Amazon VPC. (To check
the health of resources in a VPC, the health checker must also be in the
VPC.)

* You want to use a third-party health checker regardless of where your
resources are.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

Here's how custom health checks work:

You create a service and specify a value for FailureThreshold.

The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.

You register an instance.

You configure a third-party health checker to monitor the resource that is associated with the new instance.

AWS Cloud Map doesn't check the health of the resource directly.

The third-party health-checker determines that the resource is unhealthy and notifies your application.

Your application submits an UpdateInstanceCustomHealthStatus request.

AWS Cloud Map waits for (FailureThreshold x 30) seconds.

If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.

Note the following about configuring custom health checks.

func (HealthCheckCustomConfig) GoString Uses

func (s HealthCheckCustomConfig) GoString() string

GoString returns the string representation

func (*HealthCheckCustomConfig) SetFailureThreshold Uses

func (s *HealthCheckCustomConfig) SetFailureThreshold(v int64) *HealthCheckCustomConfig

SetFailureThreshold sets the FailureThreshold field's value.

func (HealthCheckCustomConfig) String Uses

func (s HealthCheckCustomConfig) String() string

String returns the string representation

func (*HealthCheckCustomConfig) Validate Uses

func (s *HealthCheckCustomConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HttpInstanceSummary Uses

type HttpInstanceSummary struct {

    // If you included any attributes when you registered the instance, the values
    // of those attributes.
    Attributes map[string]*string `type:"map"`

    // If you configured health checking in the service, the current health status
    // of the service instance.
    HealthStatus *string `type:"string" enum:"HealthStatus"`

    // The ID of an instance that matches the values that you specified in the request.
    InstanceId *string `type:"string"`

    // The name of the namespace that you specified when you registered the instance.
    NamespaceName *string `type:"string"`

    // The name of the service that you specified when you registered the instance.
    ServiceName *string `type:"string"`
    // contains filtered or unexported fields
}

In a response to a DiscoverInstance request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.

func (HttpInstanceSummary) GoString Uses

func (s HttpInstanceSummary) GoString() string

GoString returns the string representation

func (*HttpInstanceSummary) SetAttributes Uses

func (s *HttpInstanceSummary) SetAttributes(v map[string]*string) *HttpInstanceSummary

SetAttributes sets the Attributes field's value.

func (*HttpInstanceSummary) SetHealthStatus Uses

func (s *HttpInstanceSummary) SetHealthStatus(v string) *HttpInstanceSummary

SetHealthStatus sets the HealthStatus field's value.

func (*HttpInstanceSummary) SetInstanceId Uses

func (s *HttpInstanceSummary) SetInstanceId(v string) *HttpInstanceSummary

SetInstanceId sets the InstanceId field's value.

func (*HttpInstanceSummary) SetNamespaceName Uses

func (s *HttpInstanceSummary) SetNamespaceName(v string) *HttpInstanceSummary

SetNamespaceName sets the NamespaceName field's value.

func (*HttpInstanceSummary) SetServiceName Uses

func (s *HttpInstanceSummary) SetServiceName(v string) *HttpInstanceSummary

SetServiceName sets the ServiceName field's value.

func (HttpInstanceSummary) String Uses

func (s HttpInstanceSummary) String() string

String returns the string representation

type HttpProperties Uses

type HttpProperties struct {

    // The name of an HTTP namespace.
    HttpName *string `type:"string"`
    // contains filtered or unexported fields
}

A complex type that contains the name of an HTTP namespace.

func (HttpProperties) GoString Uses

func (s HttpProperties) GoString() string

GoString returns the string representation

func (*HttpProperties) SetHttpName Uses

func (s *HttpProperties) SetHttpName(v string) *HttpProperties

SetHttpName sets the HttpName field's value.

func (HttpProperties) String Uses

func (s HttpProperties) String() string

String returns the string representation

type Instance Uses

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 AWS Cloud Map to create a Route 53 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/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, AWS Cloud Map 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 ServiceId includes 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 ServiceId includes 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 ServiceId includes 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, the port on the endpoint that
    // you want Route 53 to send requests to.
    //
    // This value is required if you specified settings for an SRV record when you
    // created the service.
    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, AWS Cloud Map updates
    //    the existing DNS records. If there's also an existing health check, AWS
    //    Cloud Map 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 AWS Cloud Map creates when you submit a RegisterInstance request.

func (Instance) GoString Uses

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetAttributes Uses

func (s *Instance) SetAttributes(v map[string]*string) *Instance

SetAttributes sets the Attributes field's value.

func (*Instance) SetCreatorRequestId Uses

func (s *Instance) SetCreatorRequestId(v string) *Instance

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*Instance) SetId Uses

func (s *Instance) SetId(v string) *Instance

SetId sets the Id field's value.

func (Instance) String Uses

func (s Instance) String() string

String returns the string representation

type InstanceSummary Uses

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.

func (InstanceSummary) GoString Uses

func (s InstanceSummary) GoString() string

GoString returns the string representation

func (*InstanceSummary) SetAttributes Uses

func (s *InstanceSummary) SetAttributes(v map[string]*string) *InstanceSummary

SetAttributes sets the Attributes field's value.

func (*InstanceSummary) SetId Uses

func (s *InstanceSummary) SetId(v string) *InstanceSummary

SetId sets the Id field's value.

func (InstanceSummary) String Uses

func (s InstanceSummary) String() string

String returns the string representation

type ListInstancesInput Uses

type ListInstancesInput struct {

    // The maximum number of instances that you want AWS Cloud Map to return in
    // the response to a ListInstances request. If you don't specify a value for
    // MaxResults, AWS Cloud Map 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
}

func (ListInstancesInput) GoString Uses

func (s ListInstancesInput) GoString() string

GoString returns the string representation

func (*ListInstancesInput) SetMaxResults Uses

func (s *ListInstancesInput) SetMaxResults(v int64) *ListInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListInstancesInput) SetNextToken Uses

func (s *ListInstancesInput) SetNextToken(v string) *ListInstancesInput

SetNextToken sets the NextToken field's value.

func (*ListInstancesInput) SetServiceId Uses

func (s *ListInstancesInput) SetServiceId(v string) *ListInstancesInput

SetServiceId sets the ServiceId field's value.

func (ListInstancesInput) String Uses

func (s ListInstancesInput) String() string

String returns the string representation

func (*ListInstancesInput) Validate Uses

func (s *ListInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListInstancesOutput Uses

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
}

func (ListInstancesOutput) GoString Uses

func (s ListInstancesOutput) GoString() string

GoString returns the string representation

func (*ListInstancesOutput) SetInstances Uses

func (s *ListInstancesOutput) SetInstances(v []*InstanceSummary) *ListInstancesOutput

SetInstances sets the Instances field's value.

func (*ListInstancesOutput) SetNextToken Uses

func (s *ListInstancesOutput) SetNextToken(v string) *ListInstancesOutput

SetNextToken sets the NextToken field's value.

func (ListInstancesOutput) String Uses

func (s ListInstancesOutput) String() string

String returns the string representation

type ListNamespacesInput Uses

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 AWS Cloud Map to return in
    // the response to a ListNamespaces request. If you don't specify a value for
    // MaxResults, AWS Cloud Map 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.
    //
    // AWS Cloud Map 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
}

func (ListNamespacesInput) GoString Uses

func (s ListNamespacesInput) GoString() string

GoString returns the string representation

func (*ListNamespacesInput) SetFilters Uses

func (s *ListNamespacesInput) SetFilters(v []*NamespaceFilter) *ListNamespacesInput

SetFilters sets the Filters field's value.

func (*ListNamespacesInput) SetMaxResults Uses

func (s *ListNamespacesInput) SetMaxResults(v int64) *ListNamespacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListNamespacesInput) SetNextToken Uses

func (s *ListNamespacesInput) SetNextToken(v string) *ListNamespacesInput

SetNextToken sets the NextToken field's value.

func (ListNamespacesInput) String Uses

func (s ListNamespacesInput) String() string

String returns the string representation

func (*ListNamespacesInput) Validate Uses

func (s *ListNamespacesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNamespacesOutput Uses

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.
    //
    // AWS Cloud Map 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
}

func (ListNamespacesOutput) GoString Uses

func (s ListNamespacesOutput) GoString() string

GoString returns the string representation

func (*ListNamespacesOutput) SetNamespaces Uses

func (s *ListNamespacesOutput) SetNamespaces(v []*NamespaceSummary) *ListNamespacesOutput

SetNamespaces sets the Namespaces field's value.

func (*ListNamespacesOutput) SetNextToken Uses

func (s *ListNamespacesOutput) SetNextToken(v string) *ListNamespacesOutput

SetNextToken sets the NextToken field's value.

func (ListNamespacesOutput) String Uses

func (s ListNamespacesOutput) String() string

String returns the string representation

type ListOperationsInput Uses

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 AWS Cloud Map to return in the
    // response to a ListOperations request. If you don't specify a value for MaxResults,
    // AWS Cloud Map 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.
    //
    // AWS Cloud Map 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
}

func (ListOperationsInput) GoString Uses

func (s ListOperationsInput) GoString() string

GoString returns the string representation

func (*ListOperationsInput) SetFilters Uses

func (s *ListOperationsInput) SetFilters(v []*OperationFilter) *ListOperationsInput

SetFilters sets the Filters field's value.

func (*ListOperationsInput) SetMaxResults Uses

func (s *ListOperationsInput) SetMaxResults(v int64) *ListOperationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListOperationsInput) SetNextToken Uses

func (s *ListOperationsInput) SetNextToken(v string) *ListOperationsInput

SetNextToken sets the NextToken field's value.

func (ListOperationsInput) String Uses

func (s ListOperationsInput) String() string

String returns the string representation

func (*ListOperationsInput) Validate Uses

func (s *ListOperationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListOperationsOutput Uses

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.
    //
    // AWS Cloud Map 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
}

func (ListOperationsOutput) GoString Uses

func (s ListOperationsOutput) GoString() string

GoString returns the string representation

func (*ListOperationsOutput) SetNextToken Uses

func (s *ListOperationsOutput) SetNextToken(v string) *ListOperationsOutput

SetNextToken sets the NextToken field's value.

func (*ListOperationsOutput) SetOperations Uses

func (s *ListOperationsOutput) SetOperations(v []*OperationSummary) *ListOperationsOutput

SetOperations sets the Operations field's value.

func (ListOperationsOutput) String Uses

func (s ListOperationsOutput) String() string

String returns the string representation

type ListServicesInput Uses

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 AWS Cloud Map to return in the
    // response to a ListServices request. If you don't specify a value for MaxResults,
    // AWS Cloud Map 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.
    //
    // AWS Cloud Map 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
}

func (ListServicesInput) GoString Uses

func (s ListServicesInput) GoString() string

GoString returns the string representation

func (*ListServicesInput) SetFilters Uses

func (s *ListServicesInput) SetFilters(v []*ServiceFilter) *ListServicesInput

SetFilters sets the Filters field's value.

func (*ListServicesInput) SetMaxResults Uses

func (s *ListServicesInput) SetMaxResults(v int64) *ListServicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListServicesInput) SetNextToken Uses

func (s *ListServicesInput) SetNextToken(v string) *ListServicesInput

SetNextToken sets the NextToken field's value.

func (ListServicesInput) String Uses

func (s ListServicesInput) String() string

String returns the string representation

func (*ListServicesInput) Validate Uses

func (s *ListServicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListServicesOutput Uses

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.
    //
    // AWS Cloud Map 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
}

func (ListServicesOutput) GoString Uses

func (s ListServicesOutput) GoString() string

GoString returns the string representation

func (*ListServicesOutput) SetNextToken Uses

func (s *ListServicesOutput) SetNextToken(v string) *ListServicesOutput

SetNextToken sets the NextToken field's value.

func (*ListServicesOutput) SetServices Uses

func (s *ListServicesOutput) SetServices(v []*ServiceSummary) *ListServicesOutput

SetServices sets the Services field's value.

func (ListServicesOutput) String Uses

func (s ListServicesOutput) String() string

String returns the string representation

type Namespace Uses

type Namespace struct {

    // The Amazon Resource Name (ARN) that AWS Cloud Map 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"`

    // 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 *string `type:"string" enum:"NamespaceType"`
    // contains filtered or unexported fields
}

A complex type that contains information about a specified namespace.

func (Namespace) GoString Uses

func (s Namespace) GoString() string

GoString returns the string representation

func (*Namespace) SetArn Uses

func (s *Namespace) SetArn(v string) *Namespace

SetArn sets the Arn field's value.

func (*Namespace) SetCreateDate Uses

func (s *Namespace) SetCreateDate(v time.Time) *Namespace

SetCreateDate sets the CreateDate field's value.

func (*Namespace) SetCreatorRequestId Uses

func (s *Namespace) SetCreatorRequestId(v string) *Namespace

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*Namespace) SetDescription Uses

func (s *Namespace) SetDescription(v string) *Namespace

SetDescription sets the Description field's value.

func (*Namespace) SetId Uses

func (s *Namespace) SetId(v string) *Namespace

SetId sets the Id field's value.

func (*Namespace) SetName Uses

func (s *Namespace) SetName(v string) *Namespace

SetName sets the Name field's value.

func (*Namespace) SetProperties Uses

func (s *Namespace) SetProperties(v *NamespaceProperties) *Namespace

SetProperties sets the Properties field's value.

func (*Namespace) SetServiceCount Uses

func (s *Namespace) SetServiceCount(v int64) *Namespace

SetServiceCount sets the ServiceCount field's value.

func (*Namespace) SetType Uses

func (s *Namespace) SetType(v string) *Namespace

SetType sets the Type field's value.

func (Namespace) String Uses

func (s Namespace) String() string

String returns the string representation

type NamespaceFilter Uses

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 *string `type:"string" enum:"FilterCondition"`

    // Specify TYPE.
    //
    // Name is a required field
    Name *string `type:"string" required:"true" enum:"NamespaceFilterName"`

    // 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.

func (NamespaceFilter) GoString Uses

func (s NamespaceFilter) GoString() string

GoString returns the string representation

func (*NamespaceFilter) SetCondition Uses

func (s *NamespaceFilter) SetCondition(v string) *NamespaceFilter

SetCondition sets the Condition field's value.

func (*NamespaceFilter) SetName Uses

func (s *NamespaceFilter) SetName(v string) *NamespaceFilter

SetName sets the Name field's value.

func (*NamespaceFilter) SetValues Uses

func (s *NamespaceFilter) SetValues(v []*string) *NamespaceFilter

SetValues sets the Values field's value.

func (NamespaceFilter) String Uses

func (s NamespaceFilter) String() string

String returns the string representation

func (*NamespaceFilter) Validate Uses

func (s *NamespaceFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NamespaceProperties Uses

type NamespaceProperties struct {

    // A complex type that contains the ID for the Route 53 hosted zone that AWS
    // Cloud Map creates when you create a namespace.
    DnsProperties *DnsProperties `type:"structure"`

    // A complex type that contains the name of an HTTP namespace.
    HttpProperties *HttpProperties `type:"structure"`
    // contains filtered or unexported fields
}

A complex type that contains information that is specific to the namespace type.

func (NamespaceProperties) GoString Uses

func (s NamespaceProperties) GoString() string

GoString returns the string representation

func (*NamespaceProperties) SetDnsProperties Uses

func (s *NamespaceProperties) SetDnsProperties(v *DnsProperties) *NamespaceProperties

SetDnsProperties sets the DnsProperties field's value.

func (*NamespaceProperties) SetHttpProperties Uses

func (s *NamespaceProperties) SetHttpProperties(v *HttpProperties) *NamespaceProperties

SetHttpProperties sets the HttpProperties field's value.

func (NamespaceProperties) String Uses

func (s NamespaceProperties) String() string

String returns the string representation

type NamespaceSummary Uses

type NamespaceSummary struct {

    // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace
    // when you create it.
    Arn *string `type:"string"`

    // The date and time that the namespace was created.
    CreateDate *time.Time `type:"timestamp"`

    // A description for the namespace.
    Description *string `type:"string"`

    // The ID of the namespace.
    Id  *string `type:"string"`

    // The name of the namespace. When you create a namespace, AWS Cloud Map automatically
    // creates a Route 53 hosted zone that has the same name as the namespace.
    Name *string `type:"string"`

    // A complex type that contains information that is specific to the namespace
    // type.
    Properties *NamespaceProperties `type:"structure"`

    // The number of services that were created using the namespace.
    ServiceCount *int64 `type:"integer"`

    // The type of the namespace, either public or private.
    Type *string `type:"string" enum:"NamespaceType"`
    // contains filtered or unexported fields
}

A complex type that contains information about a namespace.

func (NamespaceSummary) GoString Uses

func (s NamespaceSummary) GoString() string

GoString returns the string representation

func (*NamespaceSummary) SetArn Uses

func (s *NamespaceSummary) SetArn(v string) *NamespaceSummary

SetArn sets the Arn field's value.

func (*NamespaceSummary) SetCreateDate Uses

func (s *NamespaceSummary) SetCreateDate(v time.Time) *NamespaceSummary

SetCreateDate sets the CreateDate field's value.

func (*NamespaceSummary) SetDescription Uses

func (s *NamespaceSummary) SetDescription(v string) *NamespaceSummary

SetDescription sets the Description field's value.

func (*NamespaceSummary) SetId Uses

func (s *NamespaceSummary) SetId(v string) *NamespaceSummary

SetId sets the Id field's value.

func (*NamespaceSummary) SetName Uses

func (s *NamespaceSummary) SetName(v string) *NamespaceSummary

SetName sets the Name field's value.

func (*NamespaceSummary) SetProperties Uses

func (s *NamespaceSummary) SetProperties(v *NamespaceProperties) *NamespaceSummary

SetProperties sets the Properties field's value.

func (*NamespaceSummary) SetServiceCount Uses

func (s *NamespaceSummary) SetServiceCount(v int64) *NamespaceSummary

SetServiceCount sets the ServiceCount field's value.

func (*NamespaceSummary) SetType Uses

func (s *NamespaceSummary) SetType(v string) *NamespaceSummary

SetType sets the Type field's value.

func (NamespaceSummary) String Uses

func (s NamespaceSummary) String() string

String returns the string representation

type Operation Uses

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

    // 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: AWS Cloud Map is performing the operation.
    //
    //    * SUCCESS: The operation succeeded.
    //
    //    * FAIL: The operation failed. For the failure reason, see ErrorMessage.
    Status *string `type:"string" enum:"OperationStatus"`

    // 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 *string `type:"string" enum:"OperationType"`

    // 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"`
    // contains filtered or unexported fields
}

A complex type that contains information about a specified operation.

func (Operation) GoString Uses

func (s Operation) GoString() string

GoString returns the string representation

func (*Operation) SetCreateDate Uses

func (s *Operation) SetCreateDate(v time.Time) *Operation

SetCreateDate sets the CreateDate field's value.

func (*Operation) SetErrorCode Uses

func (s *Operation) SetErrorCode(v string) *Operation

SetErrorCode sets the ErrorCode field's value.

func (*Operation) SetErrorMessage Uses

func (s *Operation) SetErrorMessage(v string) *Operation

SetErrorMessage sets the ErrorMessage field's value.

func (*Operation) SetId Uses

func (s *Operation) SetId(v string) *Operation

SetId sets the Id field's value.

func (*Operation) SetStatus Uses

func (s *Operation) SetStatus(v string) *Operation

SetStatus sets the Status field's value.

func (*Operation) SetTargets Uses

func (s *Operation) SetTargets(v map[string]*string) *Operation

SetTargets sets the Targets field's value.

func (*Operation) SetType Uses

func (s *Operation) SetType(v string) *Operation

SetType sets the Type field's value.

func (*Operation) SetUpdateDate Uses

func (s *Operation) SetUpdateDate(v time.Time) *Operation

SetUpdateDate sets the UpdateDate field's value.

func (Operation) String Uses

func (s Operation) String() string

String returns the string representation

type OperationFilter Uses

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 *string `type:"string" enum:"FilterCondition"`

    // 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 *string `type:"string" required:"true" enum:"OperationFilterName"`

    // 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.

func (OperationFilter) GoString Uses

func (s OperationFilter) GoString() string

GoString returns the string representation

func (*OperationFilter) SetCondition Uses

func (s *OperationFilter) SetCondition(v string) *OperationFilter

SetCondition sets the Condition field's value.

func (*OperationFilter) SetName Uses

func (s *OperationFilter) SetName(v string) *OperationFilter

SetName sets the Name field's value.

func (*OperationFilter) SetValues Uses

func (s *OperationFilter) SetValues(v []*string) *OperationFilter

SetValues sets the Values field's value.

func (OperationFilter) String Uses

func (s OperationFilter) String() string

String returns the string representation

func (*OperationFilter) Validate Uses

func (s *OperationFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OperationSummary Uses

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: AWS Cloud Map is performing the operation.
    //
    //    * SUCCESS: The operation succeeded.
    //
    //    * FAIL: The operation failed. For the failure reason, see ErrorMessage.
    Status *string `type:"string" enum:"OperationStatus"`
    // 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.

func (OperationSummary) GoString Uses

func (s OperationSummary) GoString() string

GoString returns the string representation

func (*OperationSummary) SetId Uses

func (s *OperationSummary) SetId(v string) *OperationSummary

SetId sets the Id field's value.

func (*OperationSummary) SetStatus Uses

func (s *OperationSummary) SetStatus(v string) *OperationSummary

SetStatus sets the Status field's value.

func (OperationSummary) String Uses

func (s OperationSummary) String() string

String returns the string representation

type RegisterInstanceInput Uses

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 AWS Cloud Map to create an Amazon Route 53 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/Route53/latest/APIReference/API_AliasTarget.html)
    // in the Route 53 API Reference.
    //
    // 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, AWS Cloud Map will create the Route 53 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_INIT_HEALTH_STATUS
    //
    // If the service configuration includes HealthCheckCustomConfig, you can optionally
    // use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health
    // check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS,
    // the initial status is HEALTHY.
    //
    // 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 ServiceId includes 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 ServiceId includes 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 ServiceId includes 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, the port on the endpoint that
    // you want Route 53 to send requests to.
    //
    // This value is required if you specified settings for an SRV record when you
    // created the service.
    //
    // Custom attributes
    //
    // You can add up to 30 custom attributes. For each key-value pair, the maximum
    // length of the attribute name is 255 characters, and the maximum length of
    // the attribute value is 1,024 characters.
    //
    // 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, AWS Cloud Map updates
    //    the existing DNS records, if any. If there's also an existing health check,
    //    AWS Cloud Map 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 instance.
    //
    // ServiceId is a required field
    ServiceId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (RegisterInstanceInput) GoString Uses

func (s RegisterInstanceInput) GoString() string

GoString returns the string representation

func (*RegisterInstanceInput) SetAttributes Uses

func (s *RegisterInstanceInput) SetAttributes(v map[string]*string) *RegisterInstanceInput

SetAttributes sets the Attributes field's value.

func (*RegisterInstanceInput) SetCreatorRequestId Uses

func (s *RegisterInstanceInput) SetCreatorRequestId(v string) *RegisterInstanceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*RegisterInstanceInput) SetInstanceId Uses

func (s *RegisterInstanceInput) SetInstanceId(v string) *RegisterInstanceInput

SetInstanceId sets the InstanceId field's value.

func (*RegisterInstanceInput) SetServiceId Uses

func (s *RegisterInstanceInput) SetServiceId(v string) *RegisterInstanceInput

SetServiceId sets the ServiceId field's value.

func (RegisterInstanceInput) String Uses

func (s RegisterInstanceInput) String() string

String returns the string representation

func (*RegisterInstanceInput) Validate Uses

func (s *RegisterInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterInstanceOutput Uses

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
}

func (RegisterInstanceOutput) GoString Uses

func (s RegisterInstanceOutput) GoString() string

GoString returns the string representation

func (*RegisterInstanceOutput) SetOperationId Uses

func (s *RegisterInstanceOutput) SetOperationId(v string) *RegisterInstanceOutput

SetOperationId sets the OperationId field's value.

func (RegisterInstanceOutput) String Uses

func (s RegisterInstanceOutput) String() string

String returns the string representation

type Service Uses

type Service struct {

    // The Amazon Resource Name (ARN) that AWS Cloud Map 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"`

    // 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 Route 53 DNS records that
    // you want AWS Cloud Map 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, AWS Cloud
    // Map associates the health check with the records that you specify in DnsConfig.
    //
    // For information about the charges for health checks, see Amazon Route 53
    // Pricing (http://aws.amazon.com/route53/pricing/).
    HealthCheckConfig *HealthCheckConfig `type:"structure"`

    // A complex type that contains information about an optional custom health
    // check.
    //
    // If you specify a health check configuration, you can specify either HealthCheckCustomConfig
    // or HealthCheckConfig but not both.
    HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"`

    // The ID that AWS Cloud Map 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"`

    // The ID of the namespace that was used to create the service.
    NamespaceId *string `type:"string"`
    // contains filtered or unexported fields
}

A complex type that contains information about the specified service.

func (Service) GoString Uses

func (s Service) GoString() string

GoString returns the string representation

func (*Service) SetArn Uses

func (s *Service) SetArn(v string) *Service

SetArn sets the Arn field's value.

func (*Service) SetCreateDate Uses

func (s *Service) SetCreateDate(v time.Time) *Service

SetCreateDate sets the CreateDate field's value.

func (*Service) SetCreatorRequestId Uses

func (s *Service) SetCreatorRequestId(v string) *Service

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*Service) SetDescription Uses

func (s *Service) SetDescription(v string) *Service

SetDescription sets the Description field's value.

func (*Service) SetDnsConfig Uses

func (s *Service) SetDnsConfig(v *DnsConfig) *Service

SetDnsConfig sets the DnsConfig field's value.

func (*Service) SetHealthCheckConfig Uses

func (s *Service) SetHealthCheckConfig(v *HealthCheckConfig) *Service

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (*Service) SetHealthCheckCustomConfig Uses

func (s *Service) SetHealthCheckCustomConfig(v *HealthCheckCustomConfig) *Service

SetHealthCheckCustomConfig sets the HealthCheckCustomConfig field's value.

func (*Service) SetId Uses

func (s *Service) SetId(v string) *Service

SetId sets the Id field's value.

func (*Service) SetInstanceCount Uses

func (s *Service) SetInstanceCount(v int64) *Service

SetInstanceCount sets the InstanceCount field's value.

func (*Service) SetName Uses

func (s *Service) SetName(v string) *Service

SetName sets the Name field's value.

func (*Service) SetNamespaceId Uses

func (s *Service) SetNamespaceId(v string) *Service

SetNamespaceId sets the NamespaceId field's value.

func (Service) String Uses

func (s Service) String() string

String returns the string representation

type ServiceChange Uses

type ServiceChange struct {

    // A description for the service.
    Description *string `type:"string"`

    // A complex type that contains information about the Route 53 DNS records that
    // you want AWS Cloud Map 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, AWS Cloud
    // Map associates the health check with the records that you specify in DnsConfig.
    //
    // If you specify a health check configuration, you can specify either HealthCheckCustomConfig
    // or HealthCheckConfig but not both.
    //
    // Health checks are basic Route 53 health checks that monitor an AWS endpoint.
    // For information about pricing for health checks, see Amazon Route 53 Pricing
    // (http://aws.amazon.com/route53/pricing/).
    //
    // Note the following about configuring health checks.
    //
    // A and AAAA records
    //
    // If DnsConfig includes configurations for both A and AAAA records, AWS Cloud
    // Map 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
    //
    // A Route 53 health checker in each health-checking region sends a health check
    // request to an endpoint every 30 seconds. On average, your endpoint receives
    // a health check request about every two seconds. However, health checkers
    // 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,
    // AWS Cloud Map creates a Route 53 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.
    //
    // Charges for health checks
    //
    // Health checks are basic Route 53 health checks that monitor an AWS endpoint.
    // For information about pricing for health checks, see Amazon 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.

func (ServiceChange) GoString Uses

func (s ServiceChange) GoString() string

GoString returns the string representation

func (*ServiceChange) SetDescription Uses

func (s *ServiceChange) SetDescription(v string) *ServiceChange

SetDescription sets the Description field's value.

func (*ServiceChange) SetDnsConfig Uses

func (s *ServiceChange) SetDnsConfig(v *DnsConfigChange) *ServiceChange

SetDnsConfig sets the DnsConfig field's value.

func (*ServiceChange) SetHealthCheckConfig Uses

func (s *ServiceChange) SetHealthCheckConfig(v *HealthCheckConfig) *ServiceChange

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (ServiceChange) String Uses

func (s ServiceChange) String() string

String returns the string representation

func (*ServiceChange) Validate Uses

func (s *ServiceChange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceDiscovery Uses

type ServiceDiscovery struct {
    *client.Client
}

ServiceDiscovery provides the API operation methods for making requests to AWS Cloud Map. 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 Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ServiceDiscovery

New creates a new instance of the ServiceDiscovery client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a ServiceDiscovery client from just a session.
svc := servicediscovery.New(mySession)

// Create a ServiceDiscovery client with additional configuration
svc := servicediscovery.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ServiceDiscovery) CreateHttpNamespace Uses

func (c *ServiceDiscovery) CreateHttpNamespace(input *CreateHttpNamespaceInput) (*CreateHttpNamespaceOutput, error)

CreateHttpNamespace API operation for AWS Cloud Map.

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

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits (http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreateHttpNamespace for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeNamespaceAlreadyExists "NamespaceAlreadyExists"
The namespace that you're trying to create already exists.

* ErrCodeResourceLimitExceeded "ResourceLimitExceeded"
The resource can't be created because you've reached the limit on the number
of resources.

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespace

func (*ServiceDiscovery) CreateHttpNamespaceRequest Uses

func (c *ServiceDiscovery) CreateHttpNamespaceRequest(input *CreateHttpNamespaceInput) (req *request.Request, output *CreateHttpNamespaceOutput)

CreateHttpNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreateHttpNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateHttpNamespace for more information on using the CreateHttpNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateHttpNamespaceRequest method.
req, resp := client.CreateHttpNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespace

func (*ServiceDiscovery) CreateHttpNamespaceWithContext Uses

func (c *ServiceDiscovery) CreateHttpNamespaceWithContext(ctx aws.Context, input *CreateHttpNamespaceInput, opts ...request.Option) (*CreateHttpNamespaceOutput, error)

CreateHttpNamespaceWithContext is the same as CreateHttpNamespace with the addition of the ability to pass a context and additional request options.

See CreateHttpNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) CreatePrivateDnsNamespace Uses

func (c *ServiceDiscovery) CreatePrivateDnsNamespace(input *CreatePrivateDnsNamespaceInput) (*CreatePrivateDnsNamespaceOutput, error)

CreatePrivateDnsNamespace API operation for AWS Cloud Map.

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits (http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreatePrivateDnsNamespace for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeNamespaceAlreadyExists "NamespaceAlreadyExists"
The namespace that you're trying to create already exists.

* ErrCodeResourceLimitExceeded "ResourceLimitExceeded"
The resource can't be created because you've reached the limit on the number
of resources.

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespace

func (*ServiceDiscovery) CreatePrivateDnsNamespaceRequest Uses

func (c *ServiceDiscovery) CreatePrivateDnsNamespaceRequest(input *CreatePrivateDnsNamespaceInput) (req *request.Request, output *CreatePrivateDnsNamespaceOutput)

CreatePrivateDnsNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreatePrivateDnsNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePrivateDnsNamespace for more information on using the CreatePrivateDnsNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePrivateDnsNamespaceRequest method.
req, resp := client.CreatePrivateDnsNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespace

func (*ServiceDiscovery) CreatePrivateDnsNamespaceWithContext Uses

func (c *ServiceDiscovery) CreatePrivateDnsNamespaceWithContext(ctx aws.Context, input *CreatePrivateDnsNamespaceInput, opts ...request.Option) (*CreatePrivateDnsNamespaceOutput, error)

CreatePrivateDnsNamespaceWithContext is the same as CreatePrivateDnsNamespace with the addition of the ability to pass a context and additional request options.

See CreatePrivateDnsNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) CreatePublicDnsNamespace Uses

func (c *ServiceDiscovery) CreatePublicDnsNamespace(input *CreatePublicDnsNamespaceInput) (*CreatePublicDnsNamespaceOutput, error)

CreatePublicDnsNamespace API operation for AWS Cloud Map.

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits (http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreatePublicDnsNamespace for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeNamespaceAlreadyExists "NamespaceAlreadyExists"
The namespace that you're trying to create already exists.

* ErrCodeResourceLimitExceeded "ResourceLimitExceeded"
The resource can't be created because you've reached the limit on the number
of resources.

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespace

func (*ServiceDiscovery) CreatePublicDnsNamespaceRequest Uses

func (c *ServiceDiscovery) CreatePublicDnsNamespaceRequest(input *CreatePublicDnsNamespaceInput) (req *request.Request, output *CreatePublicDnsNamespaceOutput)

CreatePublicDnsNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreatePublicDnsNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePublicDnsNamespace for more information on using the CreatePublicDnsNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePublicDnsNamespaceRequest method.
req, resp := client.CreatePublicDnsNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespace

func (*ServiceDiscovery) CreatePublicDnsNamespaceWithContext Uses

func (c *ServiceDiscovery) CreatePublicDnsNamespaceWithContext(ctx aws.Context, input *CreatePublicDnsNamespaceInput, opts ...request.Option) (*CreatePublicDnsNamespaceOutput, error)

CreatePublicDnsNamespaceWithContext is the same as CreatePublicDnsNamespace with the addition of the ability to pass a context and additional request options.

See CreatePublicDnsNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) CreateService Uses

func (c *ServiceDiscovery) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)

CreateService API operation for AWS Cloud Map.

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

* For public and private DNS namespaces, one of the following combinations
of DNS records in Amazon Route 53: A AAAA A and AAAA SRV CNAME

* Optionally, a health check

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

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits (http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreateService for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeResourceLimitExceeded "ResourceLimitExceeded"
The resource can't be created because you've reached the limit on the number
of resources.

* ErrCodeNamespaceNotFound "NamespaceNotFound"
No namespace exists with the specified ID.

* ErrCodeServiceAlreadyExists "ServiceAlreadyExists"
The service can't be created because a service with the same name already
exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService

func (*ServiceDiscovery) CreateServiceRequest Uses

func (c *ServiceDiscovery) CreateServiceRequest(input *CreateServiceInput) (req *request.Request, output *CreateServiceOutput)

CreateServiceRequest generates a "aws/request.Request" representing the client's request for the CreateService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateService for more information on using the CreateService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateServiceRequest method.
req, resp := client.CreateServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService

func (*ServiceDiscovery) CreateServiceWithContext Uses

func (c *ServiceDiscovery) CreateServiceWithContext(ctx aws.Context, input *CreateServiceInput, opts ...request.Option) (*CreateServiceOutput, error)

CreateServiceWithContext is the same as CreateService with the addition of the ability to pass a context and additional request options.

See CreateService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) DeleteNamespace Uses

func (c *ServiceDiscovery) DeleteNamespace(input *DeleteNamespaceInput) (*DeleteNamespaceOutput, error)

DeleteNamespace API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DeleteNamespace for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeNamespaceNotFound "NamespaceNotFound"
No namespace exists with the specified ID.

* ErrCodeResourceInUse "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.

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespace

func (*ServiceDiscovery) DeleteNamespaceRequest Uses

func (c *ServiceDiscovery) DeleteNamespaceRequest(input *DeleteNamespaceInput) (req *request.Request, output *DeleteNamespaceOutput)

DeleteNamespaceRequest generates a "aws/request.Request" representing the client's request for the DeleteNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNamespace for more information on using the DeleteNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteNamespaceRequest method.
req, resp := client.DeleteNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespace

func (*ServiceDiscovery) DeleteNamespaceWithContext Uses

func (c *ServiceDiscovery) DeleteNamespaceWithContext(ctx aws.Context, input *DeleteNamespaceInput, opts ...request.Option) (*DeleteNamespaceOutput, error)

DeleteNamespaceWithContext is the same as DeleteNamespace with the addition of the ability to pass a context and additional request options.

See DeleteNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) DeleteService Uses

func (c *ServiceDiscovery) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)

DeleteService API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DeleteService for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

* ErrCodeResourceInUse "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.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService

func (*ServiceDiscovery) DeleteServiceRequest Uses

func (c *ServiceDiscovery) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Request, output *DeleteServiceOutput)

DeleteServiceRequest generates a "aws/request.Request" representing the client's request for the DeleteService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteService for more information on using the DeleteService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteServiceRequest method.
req, resp := client.DeleteServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService

func (*ServiceDiscovery) DeleteServiceWithContext Uses

func (c *ServiceDiscovery) DeleteServiceWithContext(ctx aws.Context, input *DeleteServiceInput, opts ...request.Option) (*DeleteServiceOutput, error)

DeleteServiceWithContext is the same as DeleteService with the addition of the ability to pass a context and additional request options.

See DeleteService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) DeregisterInstance Uses

func (c *ServiceDiscovery) DeregisterInstance(input *DeregisterInstanceInput) (*DeregisterInstanceOutput, error)

DeregisterInstance API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DeregisterInstance for usage and error information.

Returned Error Codes:

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeInstanceNotFound "InstanceNotFound"
No instance exists with the specified ID, or the instance was recently registered,
and information about the instance hasn't propagated yet.

* ErrCodeResourceInUse "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.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstance

func (*ServiceDiscovery) DeregisterInstanceRequest Uses

func (c *ServiceDiscovery) DeregisterInstanceRequest(input *DeregisterInstanceInput) (req *request.Request, output *DeregisterInstanceOutput)

DeregisterInstanceRequest generates a "aws/request.Request" representing the client's request for the DeregisterInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterInstance for more information on using the DeregisterInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterInstanceRequest method.
req, resp := client.DeregisterInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstance

func (*ServiceDiscovery) DeregisterInstanceWithContext Uses

func (c *ServiceDiscovery) DeregisterInstanceWithContext(ctx aws.Context, input *DeregisterInstanceInput, opts ...request.Option) (*DeregisterInstanceOutput, error)

DeregisterInstanceWithContext is the same as DeregisterInstance with the addition of the ability to pass a context and additional request options.

See DeregisterInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) DiscoverInstances Uses

func (c *ServiceDiscovery) DiscoverInstances(input *DiscoverInstancesInput) (*DiscoverInstancesOutput, error)

DiscoverInstances API operation for AWS Cloud Map.

Discovers registered instances for a specified namespace and service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DiscoverInstances for usage and error information.

Returned Error Codes:

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

* ErrCodeNamespaceNotFound "NamespaceNotFound"
No namespace exists with the specified ID.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstances

func (*ServiceDiscovery) DiscoverInstancesRequest Uses

func (c *ServiceDiscovery) DiscoverInstancesRequest(input *DiscoverInstancesInput) (req *request.Request, output *DiscoverInstancesOutput)

DiscoverInstancesRequest generates a "aws/request.Request" representing the client's request for the DiscoverInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DiscoverInstances for more information on using the DiscoverInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DiscoverInstancesRequest method.
req, resp := client.DiscoverInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstances

func (*ServiceDiscovery) DiscoverInstancesWithContext Uses

func (c *ServiceDiscovery) DiscoverInstancesWithContext(ctx aws.Context, input *DiscoverInstancesInput, opts ...request.Option) (*DiscoverInstancesOutput, error)

DiscoverInstancesWithContext is the same as DiscoverInstances with the addition of the ability to pass a context and additional request options.

See DiscoverInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) GetInstance Uses

func (c *ServiceDiscovery) GetInstance(input *GetInstanceInput) (*GetInstanceOutput, error)

GetInstance API operation for AWS Cloud Map.

Gets information about a specified instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetInstance for usage and error information.

Returned Error Codes:

* ErrCodeInstanceNotFound "InstanceNotFound"
No instance exists with the specified ID, or the instance was recently registered,
and information about the instance hasn't propagated yet.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance

func (*ServiceDiscovery) GetInstanceRequest Uses

func (c *ServiceDiscovery) GetInstanceRequest(input *GetInstanceInput) (req *request.Request, output *GetInstanceOutput)

GetInstanceRequest generates a "aws/request.Request" representing the client's request for the GetInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstance for more information on using the GetInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceRequest method.
req, resp := client.GetInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance

func (*ServiceDiscovery) GetInstanceWithContext Uses

func (c *ServiceDiscovery) GetInstanceWithContext(ctx aws.Context, input *GetInstanceInput, opts ...request.Option) (*GetInstanceOutput, error)

GetInstanceWithContext is the same as GetInstance with the addition of the ability to pass a context and additional request options.

See GetInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) GetInstancesHealthStatus Uses

func (c *ServiceDiscovery) GetInstancesHealthStatus(input *GetInstancesHealthStatusInput) (*GetInstancesHealthStatusOutput, error)

GetInstancesHealthStatus API operation for AWS Cloud Map.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetInstancesHealthStatus for usage and error information.

Returned Error Codes:

* ErrCodeInstanceNotFound "InstanceNotFound"
No instance exists with the specified ID, or the instance was recently registered,
and information about the instance hasn't propagated yet.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatus

func (*ServiceDiscovery) GetInstancesHealthStatusPages Uses

func (c *ServiceDiscovery) GetInstancesHealthStatusPages(input *GetInstancesHealthStatusInput, fn func(*GetInstancesHealthStatusOutput, bool) bool) error

GetInstancesHealthStatusPages iterates over the pages of a GetInstancesHealthStatus operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetInstancesHealthStatus method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetInstancesHealthStatus operation.
pageNum := 0
err := client.GetInstancesHealthStatusPages(params,
    func(page *servicediscovery.GetInstancesHealthStatusOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) GetInstancesHealthStatusPagesWithContext Uses

func (c *ServiceDiscovery) GetInstancesHealthStatusPagesWithContext(ctx aws.Context, input *GetInstancesHealthStatusInput, fn func(*GetInstancesHealthStatusOutput, bool) bool, opts ...request.Option) error

GetInstancesHealthStatusPagesWithContext same as GetInstancesHealthStatusPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) GetInstancesHealthStatusRequest Uses

func (c *ServiceDiscovery) GetInstancesHealthStatusRequest(input *GetInstancesHealthStatusInput) (req *request.Request, output *GetInstancesHealthStatusOutput)

GetInstancesHealthStatusRequest generates a "aws/request.Request" representing the client's request for the GetInstancesHealthStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstancesHealthStatus for more information on using the GetInstancesHealthStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstancesHealthStatusRequest method.
req, resp := client.GetInstancesHealthStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatus

func (*ServiceDiscovery) GetInstancesHealthStatusWithContext Uses

func (c *ServiceDiscovery) GetInstancesHealthStatusWithContext(ctx aws.Context, input *GetInstancesHealthStatusInput, opts ...request.Option) (*GetInstancesHealthStatusOutput, error)

GetInstancesHealthStatusWithContext is the same as GetInstancesHealthStatus with the addition of the ability to pass a context and additional request options.

See GetInstancesHealthStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) GetNamespace Uses

func (c *ServiceDiscovery) GetNamespace(input *GetNamespaceInput) (*GetNamespaceOutput, error)

GetNamespace API operation for AWS Cloud Map.

Gets information about a namespace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetNamespace for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeNamespaceNotFound "NamespaceNotFound"
No namespace exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespace

func (*ServiceDiscovery) GetNamespaceRequest Uses

func (c *ServiceDiscovery) GetNamespaceRequest(input *GetNamespaceInput) (req *request.Request, output *GetNamespaceOutput)

GetNamespaceRequest generates a "aws/request.Request" representing the client's request for the GetNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetNamespace for more information on using the GetNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetNamespaceRequest method.
req, resp := client.GetNamespaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespace

func (*ServiceDiscovery) GetNamespaceWithContext Uses

func (c *ServiceDiscovery) GetNamespaceWithContext(ctx aws.Context, input *GetNamespaceInput, opts ...request.Option) (*GetNamespaceOutput, error)

GetNamespaceWithContext is the same as GetNamespace with the addition of the ability to pass a context and additional request options.

See GetNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) GetOperation Uses

func (c *ServiceDiscovery) GetOperation(input *GetOperationInput) (*GetOperationOutput, error)

GetOperation API operation for AWS Cloud Map.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetOperation for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeOperationNotFound "OperationNotFound"
No operation exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperation

func (*ServiceDiscovery) GetOperationRequest Uses

func (c *ServiceDiscovery) GetOperationRequest(input *GetOperationInput) (req *request.Request, output *GetOperationOutput)

GetOperationRequest generates a "aws/request.Request" representing the client's request for the GetOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperation for more information on using the GetOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationRequest method.
req, resp := client.GetOperationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperation

func (*ServiceDiscovery) GetOperationWithContext Uses

func (c *ServiceDiscovery) GetOperationWithContext(ctx aws.Context, input *GetOperationInput, opts ...request.Option) (*GetOperationOutput, error)

GetOperationWithContext is the same as GetOperation with the addition of the ability to pass a context and additional request options.

See GetOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) GetService Uses

func (c *ServiceDiscovery) GetService(input *GetServiceInput) (*GetServiceOutput, error)

GetService API operation for AWS Cloud Map.

Gets the settings for a specified service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetService for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService

func (*ServiceDiscovery) GetServiceRequest Uses

func (c *ServiceDiscovery) GetServiceRequest(input *GetServiceInput) (req *request.Request, output *GetServiceOutput)

GetServiceRequest generates a "aws/request.Request" representing the client's request for the GetService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetService for more information on using the GetService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetServiceRequest method.
req, resp := client.GetServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService

func (*ServiceDiscovery) GetServiceWithContext Uses

func (c *ServiceDiscovery) GetServiceWithContext(ctx aws.Context, input *GetServiceInput, opts ...request.Option) (*GetServiceOutput, error)

GetServiceWithContext is the same as GetService with the addition of the ability to pass a context and additional request options.

See GetService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListInstances Uses

func (c *ServiceDiscovery) ListInstances(input *ListInstancesInput) (*ListInstancesOutput, error)

ListInstances API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListInstances for usage and error information.

Returned Error Codes:

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances

func (*ServiceDiscovery) ListInstancesPages Uses

func (c *ServiceDiscovery) ListInstancesPages(input *ListInstancesInput, fn func(*ListInstancesOutput, bool) bool) error

ListInstancesPages iterates over the pages of a ListInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListInstances operation.
pageNum := 0
err := client.ListInstancesPages(params,
    func(page *servicediscovery.ListInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) ListInstancesPagesWithContext Uses

func (c *ServiceDiscovery) ListInstancesPagesWithContext(ctx aws.Context, input *ListInstancesInput, fn func(*ListInstancesOutput, bool) bool, opts ...request.Option) error

ListInstancesPagesWithContext same as ListInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListInstancesRequest Uses

func (c *ServiceDiscovery) ListInstancesRequest(input *ListInstancesInput) (req *request.Request, output *ListInstancesOutput)

ListInstancesRequest generates a "aws/request.Request" representing the client's request for the ListInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListInstances for more information on using the ListInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListInstancesRequest method.
req, resp := client.ListInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances

func (*ServiceDiscovery) ListInstancesWithContext Uses

func (c *ServiceDiscovery) ListInstancesWithContext(ctx aws.Context, input *ListInstancesInput, opts ...request.Option) (*ListInstancesOutput, error)

ListInstancesWithContext is the same as ListInstances with the addition of the ability to pass a context and additional request options.

See ListInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListNamespaces Uses

func (c *ServiceDiscovery) ListNamespaces(input *ListNamespacesInput) (*ListNamespacesOutput, error)

ListNamespaces API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListNamespaces for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespaces

func (*ServiceDiscovery) ListNamespacesPages Uses

func (c *ServiceDiscovery) ListNamespacesPages(input *ListNamespacesInput, fn func(*ListNamespacesOutput, bool) bool) error

ListNamespacesPages iterates over the pages of a ListNamespaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNamespaces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListNamespaces operation.
pageNum := 0
err := client.ListNamespacesPages(params,
    func(page *servicediscovery.ListNamespacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) ListNamespacesPagesWithContext Uses

func (c *ServiceDiscovery) ListNamespacesPagesWithContext(ctx aws.Context, input *ListNamespacesInput, fn func(*ListNamespacesOutput, bool) bool, opts ...request.Option) error

ListNamespacesPagesWithContext same as ListNamespacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListNamespacesRequest Uses

func (c *ServiceDiscovery) ListNamespacesRequest(input *ListNamespacesInput) (req *request.Request, output *ListNamespacesOutput)

ListNamespacesRequest generates a "aws/request.Request" representing the client's request for the ListNamespaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNamespaces for more information on using the ListNamespaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNamespacesRequest method.
req, resp := client.ListNamespacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespaces

func (*ServiceDiscovery) ListNamespacesWithContext Uses

func (c *ServiceDiscovery) ListNamespacesWithContext(ctx aws.Context, input *ListNamespacesInput, opts ...request.Option) (*ListNamespacesOutput, error)

ListNamespacesWithContext is the same as ListNamespaces with the addition of the ability to pass a context and additional request options.

See ListNamespaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListOperations Uses

func (c *ServiceDiscovery) ListOperations(input *ListOperationsInput) (*ListOperationsOutput, error)

ListOperations API operation for AWS Cloud Map.

Lists operations that match the criteria that you specify.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListOperations for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperations

func (*ServiceDiscovery) ListOperationsPages Uses

func (c *ServiceDiscovery) ListOperationsPages(input *ListOperationsInput, fn func(*ListOperationsOutput, bool) bool) error

ListOperationsPages iterates over the pages of a ListOperations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOperations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListOperations operation.
pageNum := 0
err := client.ListOperationsPages(params,
    func(page *servicediscovery.ListOperationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) ListOperationsPagesWithContext Uses

func (c *ServiceDiscovery) ListOperationsPagesWithContext(ctx aws.Context, input *ListOperationsInput, fn func(*ListOperationsOutput, bool) bool, opts ...request.Option) error

ListOperationsPagesWithContext same as ListOperationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListOperationsRequest Uses

func (c *ServiceDiscovery) ListOperationsRequest(input *ListOperationsInput) (req *request.Request, output *ListOperationsOutput)

ListOperationsRequest generates a "aws/request.Request" representing the client's request for the ListOperations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOperations for more information on using the ListOperations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListOperationsRequest method.
req, resp := client.ListOperationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperations

func (*ServiceDiscovery) ListOperationsWithContext Uses

func (c *ServiceDiscovery) ListOperationsWithContext(ctx aws.Context, input *ListOperationsInput, opts ...request.Option) (*ListOperationsOutput, error)

ListOperationsWithContext is the same as ListOperations with the addition of the ability to pass a context and additional request options.

See ListOperations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListServices Uses

func (c *ServiceDiscovery) ListServices(input *ListServicesInput) (*ListServicesOutput, error)

ListServices API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListServices for usage and error information.

Returned Error Codes:

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices

func (*ServiceDiscovery) ListServicesPages Uses

func (c *ServiceDiscovery) ListServicesPages(input *ListServicesInput, fn func(*ListServicesOutput, bool) bool) error

ListServicesPages iterates over the pages of a ListServices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListServices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListServices operation.
pageNum := 0
err := client.ListServicesPages(params,
    func(page *servicediscovery.ListServicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) ListServicesPagesWithContext Uses

func (c *ServiceDiscovery) ListServicesPagesWithContext(ctx aws.Context, input *ListServicesInput, fn func(*ListServicesOutput, bool) bool, opts ...request.Option) error

ListServicesPagesWithContext same as ListServicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) ListServicesRequest Uses

func (c *ServiceDiscovery) ListServicesRequest(input *ListServicesInput) (req *request.Request, output *ListServicesOutput)

ListServicesRequest generates a "aws/request.Request" representing the client's request for the ListServices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListServices for more information on using the ListServices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListServicesRequest method.
req, resp := client.ListServicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices

func (*ServiceDiscovery) ListServicesWithContext Uses

func (c *ServiceDiscovery) ListServicesWithContext(ctx aws.Context, input *ListServicesInput, opts ...request.Option) (*ListServicesOutput, error)

ListServicesWithContext is the same as ListServices with the addition of the ability to pass a context and additional request options.

See ListServices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) RegisterInstance Uses

func (c *ServiceDiscovery) RegisterInstance(input *RegisterInstanceInput) (*RegisterInstanceOutput, error)

RegisterInstance API operation for AWS Cloud Map.

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

* For each DNS record that you define in the service that is specified
by ServiceId, a record is created or updated in the hosted zone that is
associated with the corresponding namespace.

* If the service includes HealthCheckConfig, a health check is created
based on the settings in the health check configuration.

* The health check, if any, is associated with each of the new or updated
records.

One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

For more information, see CreateService.

When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

* If the health check is healthy: returns all the records

* If the health check is unhealthy: returns the applicable value for the
last healthy instance

* If you didn't specify a health check configuration: returns all the
records

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits (http://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation RegisterInstance for usage and error information.

Returned Error Codes:

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeResourceInUse "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.

* ErrCodeResourceLimitExceeded "ResourceLimitExceeded"
The resource can't be created because you've reached the limit on the number
of resources.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstance

func (*ServiceDiscovery) RegisterInstanceRequest Uses

func (c *ServiceDiscovery) RegisterInstanceRequest(input *RegisterInstanceInput) (req *request.Request, output *RegisterInstanceOutput)

RegisterInstanceRequest generates a "aws/request.Request" representing the client's request for the RegisterInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterInstance for more information on using the RegisterInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterInstanceRequest method.
req, resp := client.RegisterInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstance

func (*ServiceDiscovery) RegisterInstanceWithContext Uses

func (c *ServiceDiscovery) RegisterInstanceWithContext(ctx aws.Context, input *RegisterInstanceInput, opts ...request.Option) (*RegisterInstanceOutput, error)

RegisterInstanceWithContext is the same as RegisterInstance with the addition of the ability to pass a context and additional request options.

See RegisterInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) UpdateInstanceCustomHealthStatus Uses

func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatus(input *UpdateInstanceCustomHealthStatusInput) (*UpdateInstanceCustomHealthStatusOutput, error)

UpdateInstanceCustomHealthStatus API operation for AWS Cloud Map.

Submits a request to change the health status of a custom health check to healthy or unhealthy.

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

For more information, see HealthCheckCustomConfig.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation UpdateInstanceCustomHealthStatus for usage and error information.

Returned Error Codes:

* ErrCodeInstanceNotFound "InstanceNotFound"
No instance exists with the specified ID, or the instance was recently registered,
and information about the instance hasn't propagated yet.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

* ErrCodeCustomHealthNotFound "CustomHealthNotFound"
The health check for the instance that is specified by ServiceId and InstanceId
is not a custom health check.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatus

func (*ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest Uses

func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest(input *UpdateInstanceCustomHealthStatusInput) (req *request.Request, output *UpdateInstanceCustomHealthStatusOutput)

UpdateInstanceCustomHealthStatusRequest generates a "aws/request.Request" representing the client's request for the UpdateInstanceCustomHealthStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateInstanceCustomHealthStatus for more information on using the UpdateInstanceCustomHealthStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateInstanceCustomHealthStatusRequest method.
req, resp := client.UpdateInstanceCustomHealthStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatus

func (*ServiceDiscovery) UpdateInstanceCustomHealthStatusWithContext Uses

func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatusWithContext(ctx aws.Context, input *UpdateInstanceCustomHealthStatusInput, opts ...request.Option) (*UpdateInstanceCustomHealthStatusOutput, error)

UpdateInstanceCustomHealthStatusWithContext is the same as UpdateInstanceCustomHealthStatus with the addition of the ability to pass a context and additional request options.

See UpdateInstanceCustomHealthStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ServiceDiscovery) UpdateService Uses

func (c *ServiceDiscovery) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)

UpdateService API operation for AWS Cloud Map.

Submits a request to perform the following operations:

* Add or delete DnsRecords configurations

* Update the TTL setting for existing DnsRecords configurations

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation UpdateService for usage and error information.

Returned Error Codes:

* ErrCodeDuplicateRequest "DuplicateRequest"
The operation is already in progress.

* ErrCodeInvalidInput "InvalidInput"
One or more specified values aren't valid. For example, a required value
might be missing, a numeric value might be outside the allowed range, or
a string value might exceed length constraints.

* ErrCodeServiceNotFound "ServiceNotFound"
No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateService

func (*ServiceDiscovery) UpdateServiceRequest Uses

func (c *ServiceDiscovery) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Request, output *UpdateServiceOutput)

UpdateServiceRequest generates a "aws/request.Request" representing the client's request for the UpdateService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateService for more information on using the UpdateService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateServiceRequest method.
req, resp := client.UpdateServiceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateService

func (*ServiceDiscovery) UpdateServiceWithContext Uses

func (c *ServiceDiscovery) UpdateServiceWithContext(ctx aws.Context, input *UpdateServiceInput, opts ...request.Option) (*UpdateServiceOutput, error)

UpdateServiceWithContext is the same as UpdateService with the addition of the ability to pass a context and additional request options.

See UpdateService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ServiceFilter Uses

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 *string `type:"string" enum:"FilterCondition"`

    // Specify NAMESPACE_ID.
    //
    // Name is a required field
    Name *string `type:"string" required:"true" enum:"ServiceFilterName"`

    // 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.

func (ServiceFilter) GoString Uses

func (s ServiceFilter) GoString() string

GoString returns the string representation

func (*ServiceFilter) SetCondition Uses

func (s *ServiceFilter) SetCondition(v string) *ServiceFilter

SetCondition sets the Condition field's value.

func (*ServiceFilter) SetName Uses

func (s *ServiceFilter) SetName(v string) *ServiceFilter

SetName sets the Name field's value.

func (*ServiceFilter) SetValues Uses

func (s *ServiceFilter) SetValues(v []*string) *ServiceFilter

SetValues sets the Values field's value.

func (ServiceFilter) String Uses

func (s ServiceFilter) String() string

String returns the string representation

func (*ServiceFilter) Validate Uses

func (s *ServiceFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceSummary Uses

type ServiceSummary struct {

    // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service
    // when you create it.
    Arn *string `type:"string"`

    // The date and time that the service was created.
    CreateDate *time.Time `type:"timestamp"`

    // The description that you specify when you create the service.
    Description *string `type:"string"`

    // A complex type that contains information about the Amazon Route 53 DNS records
    // that you want AWS Cloud Map 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, AWS Cloud
    // Map associates the health check with the records that you specify in DnsConfig.
    //
    // If you specify a health check configuration, you can specify either HealthCheckCustomConfig
    // or HealthCheckConfig but not both.
    //
    // Health checks are basic Route 53 health checks that monitor an AWS endpoint.
    // For information about pricing for health checks, see Amazon Route 53 Pricing
    // (http://aws.amazon.com/route53/pricing/).
    //
    // Note the following about configuring health checks.
    //
    // A and AAAA records
    //
    // If DnsConfig includes configurations for both A and AAAA records, AWS Cloud
    // Map 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
    //
    // A Route 53 health checker in each health-checking region sends a health check
    // request to an endpoint every 30 seconds. On average, your endpoint receives
    // a health check request about every two seconds. However, health checkers
    // 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,
    // AWS Cloud Map creates a Route 53 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.
    //
    // Charges for health checks
    //
    // Health checks are basic Route 53 health checks that monitor an AWS endpoint.
    // For information about pricing for health checks, see Amazon Route 53 Pricing
    // (http://aws.amazon.com/route53/pricing/).
    HealthCheckConfig *HealthCheckConfig `type:"structure"`

    // A complex type that contains information about an optional custom health
    // check. A custom health check, which requires that you use a third-party health
    // checker to evaluate the health of your resources, is useful in the following
    // circumstances:
    //
    //    * You can't use a health check that is defined by HealthCheckConfig because
    //    the resource isn't available over the internet. For example, you can use
    //    a custom health check when the instance is in an Amazon VPC. (To check
    //    the health of resources in a VPC, the health checker must also be in the
    //    VPC.)
    //
    //    * You want to use a third-party health checker regardless of where your
    //    resources are.
    //
    // If you specify a health check configuration, you can specify either HealthCheckCustomConfig
    // or HealthCheckConfig but not both.
    //
    // To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus
    // request. Cloud Map doesn't monitor the status of the resource, it just keeps
    // a record of the status specified in the most recent UpdateInstanceCustomHealthStatus
    // request.
    //
    // Here's how custom health checks work:
    //
    // You create a service and specify a value for FailureThreshold.
    //
    // The failure threshold indicates the number of 30-second intervals you want
    // AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus
    // request and the time that AWS Cloud Map stops routing internet traffic to
    // the corresponding resource.
    //
    // You register an instance.
    //
    // You configure a third-party health checker to monitor the resource that is
    // associated with the new instance.
    //
    // AWS Cloud Map doesn't check the health of the resource directly.
    //
    // The third-party health-checker determines that the resource is unhealthy
    // and notifies your application.
    //
    // Your application submits an UpdateInstanceCustomHealthStatus request.
    //
    // AWS Cloud Map waits for (FailureThreshold x 30) seconds.
    //
    // If another UpdateInstanceCustomHealthStatus request doesn't arrive during
    // that time to change the status back to healthy, AWS Cloud Map stops routing
    // traffic to the resource.
    //
    // Note the following about configuring custom health checks.
    HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"`

    // The ID that AWS Cloud Map 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.

func (ServiceSummary) GoString Uses

func (s ServiceSummary) GoString() string

GoString returns the string representation

func (*ServiceSummary) SetArn Uses

func (s *ServiceSummary) SetArn(v string) *ServiceSummary

SetArn sets the Arn field's value.

func (*ServiceSummary) SetCreateDate Uses

func (s *ServiceSummary) SetCreateDate(v time.Time) *ServiceSummary

SetCreateDate sets the CreateDate field's value.

func (*ServiceSummary) SetDescription Uses

func (s *ServiceSummary) SetDescription(v string) *ServiceSummary

SetDescription sets the Description field's value.

func (*ServiceSummary) SetDnsConfig Uses

func (s *ServiceSummary) SetDnsConfig(v *DnsConfig) *ServiceSummary

SetDnsConfig sets the DnsConfig field's value.

func (*ServiceSummary) SetHealthCheckConfig Uses

func (s *ServiceSummary) SetHealthCheckConfig(v *HealthCheckConfig) *ServiceSummary

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (*ServiceSummary) SetHealthCheckCustomConfig Uses

func (s *ServiceSummary) SetHealthCheckCustomConfig(v *HealthCheckCustomConfig) *ServiceSummary

SetHealthCheckCustomConfig sets the HealthCheckCustomConfig field's value.

func (*ServiceSummary) SetId Uses

func (s *ServiceSummary) SetId(v string) *ServiceSummary

SetId sets the Id field's value.

func (*ServiceSummary) SetInstanceCount Uses

func (s *ServiceSummary) SetInstanceCount(v int64) *ServiceSummary

SetInstanceCount sets the InstanceCount field's value.

func (*ServiceSummary) SetName Uses

func (s *ServiceSummary) SetName(v string) *ServiceSummary

SetName sets the Name field's value.

func (ServiceSummary) String Uses

func (s ServiceSummary) String() string

String returns the string representation

type UpdateInstanceCustomHealthStatusInput Uses

type UpdateInstanceCustomHealthStatusInput struct {

    // The ID of the instance that you want to change the health status for.
    //
    // InstanceId is a required field
    InstanceId *string `type:"string" required:"true"`

    // The ID of the service that includes the configuration for the custom health
    // check that you want to change the status for.
    //
    // ServiceId is a required field
    ServiceId *string `type:"string" required:"true"`

    // The new status of the instance, HEALTHY or UNHEALTHY.
    //
    // Status is a required field
    Status *string `type:"string" required:"true" enum:"CustomHealthStatus"`
    // contains filtered or unexported fields
}

func (UpdateInstanceCustomHealthStatusInput) GoString Uses

func (s UpdateInstanceCustomHealthStatusInput) GoString() string

GoString returns the string representation

func (*UpdateInstanceCustomHealthStatusInput) SetInstanceId Uses

func (s *UpdateInstanceCustomHealthStatusInput) SetInstanceId(v string) *UpdateInstanceCustomHealthStatusInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateInstanceCustomHealthStatusInput) SetServiceId Uses

func (s *UpdateInstanceCustomHealthStatusInput) SetServiceId(v string) *UpdateInstanceCustomHealthStatusInput

SetServiceId sets the ServiceId field's value.

func (*UpdateInstanceCustomHealthStatusInput) SetStatus Uses

func (s *UpdateInstanceCustomHealthStatusInput) SetStatus(v string) *UpdateInstanceCustomHealthStatusInput

SetStatus sets the Status field's value.

func (UpdateInstanceCustomHealthStatusInput) String Uses

func (s UpdateInstanceCustomHealthStatusInput) String() string

String returns the string representation

func (*UpdateInstanceCustomHealthStatusInput) Validate Uses

func (s *UpdateInstanceCustomHealthStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateInstanceCustomHealthStatusOutput Uses

type UpdateInstanceCustomHealthStatusOutput struct {
    // contains filtered or unexported fields
}

func (UpdateInstanceCustomHealthStatusOutput) GoString Uses

func (s UpdateInstanceCustomHealthStatusOutput) GoString() string

GoString returns the string representation

func (UpdateInstanceCustomHealthStatusOutput) String Uses

func (s UpdateInstanceCustomHealthStatusOutput) String() string

String returns the string representation

type UpdateServiceInput Uses

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
}

func (UpdateServiceInput) GoString Uses

func (s UpdateServiceInput) GoString() string

GoString returns the string representation

func (*UpdateServiceInput) SetId Uses

func (s *UpdateServiceInput) SetId(v string) *UpdateServiceInput

SetId sets the Id field's value.

func (*UpdateServiceInput) SetService Uses

func (s *UpdateServiceInput) SetService(v *ServiceChange) *UpdateServiceInput

SetService sets the Service field's value.

func (UpdateServiceInput) String Uses

func (s UpdateServiceInput) String() string

String returns the string representation

func (*UpdateServiceInput) Validate Uses

func (s *UpdateServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServiceOutput Uses

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
}

func (UpdateServiceOutput) GoString Uses

func (s UpdateServiceOutput) GoString() string

GoString returns the string representation

func (*UpdateServiceOutput) SetOperationId Uses

func (s *UpdateServiceOutput) SetOperationId(v string) *UpdateServiceOutput

SetOperationId sets the OperationId field's value.

func (UpdateServiceOutput) String Uses

func (s UpdateServiceOutput) String() string

String returns the string representation

Directories

PathSynopsis
servicediscoveryifacePackage servicediscoveryiface provides an interface to enable mocking the AWS Cloud Map service client for testing your code.

Package servicediscovery imports 10 packages (graph) and is imported by 26 packages. Updated 2019-06-07. Refresh now. Tools for package owners.