Amazonka.Route53AutoNaming.Types.ServiceInfo

Documentation

data ServiceInfo

A complex type that contains information about the specified service.

See: newServiceInfo smart constructor.

Constructors

ServiceInfo'

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

• creatorRequestId :: Maybe Text

  A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

• description :: Maybe Text

  The description of the service.

• dnsConfig :: Maybe DnsConfig

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

  The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

• healthCheckConfig :: Maybe HealthCheckConfig

  Public DNS and HTTP namespaces only. A complex type that contains 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.

  For information about the charges for health checks, see Amazon Route 53 Pricing.

• healthCheckCustomConfig :: Maybe HealthCheckCustomConfig

  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.

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

• namespaceId :: Maybe Text

  The ID of the namespace that was used to create 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 ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Methods

parseJSON :: Value -> Parser ServiceInfo

parseJSONList :: Value -> Parser [ServiceInfo]

Generic ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Associated Types

type Rep ServiceInfo :: Type -> Type

Methods

from :: ServiceInfo -> Rep ServiceInfo x

to :: Rep ServiceInfo x -> ServiceInfo

Read ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Methods

readsPrec :: Int -> ReadS ServiceInfo

readList :: ReadS [ServiceInfo]

readPrec :: ReadPrec ServiceInfo

readListPrec :: ReadPrec [ServiceInfo]

Show ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Methods

showsPrec :: Int -> ServiceInfo -> ShowS

show :: ServiceInfo -> String

showList :: [ServiceInfo] -> ShowS

NFData ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Methods

rnf :: ServiceInfo -> ()

Eq ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Methods

(==) :: ServiceInfo -> ServiceInfo -> Bool

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

Hashable ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

Methods

hashWithSalt :: Int -> ServiceInfo -> Int

hash :: ServiceInfo -> Int

type Rep ServiceInfo

Defined in Amazonka.Route53AutoNaming.Types.ServiceInfo

type Rep ServiceInfo = D1 ('MetaData "ServiceInfo" "Amazonka.Route53AutoNaming.Types.ServiceInfo" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "ServiceInfo'" '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 "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (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 "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceType)))))))

newServiceInfo :: ServiceInfo

Create a value of ServiceInfo 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:ServiceInfo', serviceInfo_arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

$sel:createDate:ServiceInfo', serviceInfo_createDate - 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.

$sel:creatorRequestId:ServiceInfo', serviceInfo_creatorRequestId - A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

$sel:description:ServiceInfo', serviceInfo_description - The description of the service.

$sel:dnsConfig:ServiceInfo', serviceInfo_dnsConfig - A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

$sel:healthCheckConfig:ServiceInfo', serviceInfo_healthCheckConfig - Public DNS and HTTP namespaces only. A complex type that contains 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.

For information about the charges for health checks, see Amazon Route 53 Pricing.

$sel:healthCheckCustomConfig:ServiceInfo', serviceInfo_healthCheckCustomConfig - 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.

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

$sel:instanceCount:ServiceInfo', serviceInfo_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:ServiceInfo', serviceInfo_name - The name of the service.

ServiceInfo, serviceInfo_namespaceId - The ID of the namespace that was used to create the service.

ServiceInfo, serviceInfo_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.

serviceInfo_arn :: Lens' ServiceInfo (Maybe Text)

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

serviceInfo_createDate :: Lens' ServiceInfo (Maybe UTCTime)

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.

serviceInfo_creatorRequestId :: Lens' ServiceInfo (Maybe Text)

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

serviceInfo_description :: Lens' ServiceInfo (Maybe Text)

The description of the service.

serviceInfo_dnsConfig :: Lens' ServiceInfo (Maybe DnsConfig)

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

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

serviceInfo_healthCheckConfig :: Lens' ServiceInfo (Maybe HealthCheckConfig)

Public DNS and HTTP namespaces only. A complex type that contains 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.

For information about the charges for health checks, see Amazon Route 53 Pricing.

serviceInfo_healthCheckCustomConfig :: Lens' ServiceInfo (Maybe HealthCheckCustomConfig)

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.

serviceInfo_id :: Lens' ServiceInfo (Maybe Text)

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

serviceInfo_instanceCount :: Lens' ServiceInfo (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.

serviceInfo_name :: Lens' ServiceInfo (Maybe Text)

The name of the service.

serviceInfo_namespaceId :: Lens' ServiceInfo (Maybe Text)

The ID of the namespace that was used to create the service.

serviceInfo_type :: Lens' ServiceInfo (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.