Amazonka.Route53AutoNaming.Types.ServiceSummary

Documentation

data ServiceSummary

A complex type that contains information about a specified service.

See: newServiceSummary smart constructor.

Constructors

ServiceSummary'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

• createDate :: Maybe POSIX

  The date and time that the service was created.

• description :: Maybe Text

  The description that you specify when you create the service.

• dnsConfig :: Maybe DnsConfig

  Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

• healthCheckConfig :: Maybe HealthCheckConfig

  Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

• healthCheckCustomConfig :: Maybe HealthCheckCustomConfig

  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's 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 located.

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

• id :: Maybe Text

  The ID that Cloud Map assigned to the service when you created it.

• instanceCount :: Maybe Int

  The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

• name :: Maybe Text

  The name of the service.

• type' :: Maybe ServiceType

  Describes the systems that can be used to discover the service instances.

  DNS_HTTP

  The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

  HTTP

  The service instances can only be discovered using the DiscoverInstances API operation.

  DNS

  Reserved.

Instances

FromJSON ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Methods

parseJSON :: Value -> Parser ServiceSummary

parseJSONList :: Value -> Parser [ServiceSummary]

Generic ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Associated Types

type Rep ServiceSummary :: Type -> Type

Methods

from :: ServiceSummary -> Rep ServiceSummary x

to :: Rep ServiceSummary x -> ServiceSummary

Read ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Methods

readsPrec :: Int -> ReadS ServiceSummary

readList :: ReadS [ServiceSummary]

readPrec :: ReadPrec ServiceSummary

readListPrec :: ReadPrec [ServiceSummary]

Show ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Methods

showsPrec :: Int -> ServiceSummary -> ShowS

show :: ServiceSummary -> String

showList :: [ServiceSummary] -> ShowS

NFData ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Methods

rnf :: ServiceSummary -> ()

Eq ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Methods

(==) :: ServiceSummary -> ServiceSummary -> Bool

(/=) :: ServiceSummary -> ServiceSummary -> Bool

Hashable ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

Methods

hashWithSalt :: Int -> ServiceSummary -> Int

hash :: ServiceSummary -> Int

type Rep ServiceSummary

Defined in Amazonka.Route53AutoNaming.Types.ServiceSummary

type Rep ServiceSummary = D1 ('MetaData "ServiceSummary" "Amazonka.Route53AutoNaming.Types.ServiceSummary" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "ServiceSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dnsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DnsConfig)) :*: S1 ('MetaSel ('Just "healthCheckConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckConfig))))) :*: ((S1 ('MetaSel ('Just "healthCheckCustomConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckCustomConfig)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "instanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceType)))))))

newServiceSummary :: ServiceSummary

Create a value of ServiceSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:ServiceSummary', serviceSummary_arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

$sel:createDate:ServiceSummary', serviceSummary_createDate - The date and time that the service was created.

$sel:description:ServiceSummary', serviceSummary_description - The description that you specify when you create the service.

$sel:dnsConfig:ServiceSummary', serviceSummary_dnsConfig - Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

$sel:healthCheckConfig:ServiceSummary', serviceSummary_healthCheckConfig - Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

$sel:healthCheckCustomConfig:ServiceSummary', serviceSummary_healthCheckCustomConfig - 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's 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 located.

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

$sel:id:ServiceSummary', serviceSummary_id - The ID that Cloud Map assigned to the service when you created it.

$sel:instanceCount:ServiceSummary', serviceSummary_instanceCount - The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

$sel:name:ServiceSummary', serviceSummary_name - The name of the service.

ServiceSummary, serviceSummary_type - Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

serviceSummary_arn :: Lens' ServiceSummary (Maybe Text)

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

serviceSummary_createDate :: Lens' ServiceSummary (Maybe UTCTime)

The date and time that the service was created.

serviceSummary_description :: Lens' ServiceSummary (Maybe Text)

The description that you specify when you create the service.

serviceSummary_dnsConfig :: Lens' ServiceSummary (Maybe DnsConfig)

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

serviceSummary_healthCheckConfig :: Lens' ServiceSummary (Maybe HealthCheckConfig)

Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

serviceSummary_healthCheckCustomConfig :: Lens' ServiceSummary (Maybe HealthCheckCustomConfig)

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's 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 located.

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

serviceSummary_id :: Lens' ServiceSummary (Maybe Text)

The ID that Cloud Map assigned to the service when you created it.

serviceSummary_instanceCount :: Lens' ServiceSummary (Maybe Int)

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

serviceSummary_name :: Lens' ServiceSummary (Maybe Text)

The name of the service.

serviceSummary_type :: Lens' ServiceSummary (Maybe ServiceType)

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.