libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53AutoNaming.CreateService

Description

Creates a service. This action 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 Cloud Map uses the values in the configuration to create the specified entities.

For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.

Synopsis

Creating a Request

data CreateService Source #

See: newCreateService smart constructor.

Constructors

CreateService' 

Fields

  • healthCheckConfig :: Maybe HealthCheckConfig

    Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, 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 Cloud Map Pricing.

  • creatorRequestId :: Maybe Text

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

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

    You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

  • namespaceId :: Maybe Text

    The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.

  • type' :: Maybe ServiceTypeOption

    If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

  • dnsConfig :: Maybe DnsConfig

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

  • description :: Maybe Text

    A description for the service.

  • tags :: Maybe [Tag]

    The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

  • name :: Text

    The name that you want to assign to the service.

    If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

    • Start the name with an underscore (_), such as _exampleservice.
    • End the name with ._protocol, such as ._tcp.

    When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

    _exampleservice._tcp.example.com).

    For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

Instances

Instances details
Eq CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Read CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Show CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Generic CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Associated Types

type Rep CreateService :: Type -> Type #

NFData CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Methods

rnf :: CreateService -> () #

Hashable CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

ToJSON CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

AWSRequest CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Associated Types

type AWSResponse CreateService #

ToHeaders CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

ToPath CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

ToQuery CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

type Rep CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

type AWSResponse CreateService Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

newCreateService Source #

Create a value of CreateService 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:healthCheckConfig:CreateService', createService_healthCheckConfig - Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, 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 Cloud Map Pricing.

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

$sel:healthCheckCustomConfig:CreateService', createService_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.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

$sel:namespaceId:CreateService', createService_namespaceId - The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.

$sel:type':CreateService', createService_type - If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

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

$sel:description:CreateService', createService_description - A description for the service.

$sel:tags:CreateService', createService_tags - The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

$sel:name:CreateService', createService_name - The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.
  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

Request Lenses

createService_healthCheckConfig :: Lens' CreateService (Maybe HealthCheckConfig) Source #

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, 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 Cloud Map Pricing.

createService_creatorRequestId :: Lens' CreateService (Maybe Text) Source #

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

createService_healthCheckCustomConfig :: Lens' CreateService (Maybe HealthCheckCustomConfig) Source #

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.

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.

createService_namespaceId :: Lens' CreateService (Maybe Text) Source #

The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the DnsConfig object.

createService_type :: Lens' CreateService (Maybe ServiceTypeOption) Source #

If present, specifies that the service instances are only discoverable using the DiscoverInstances API operation. No DNS records is registered for the service instances. The only valid value is HTTP.

createService_dnsConfig :: Lens' CreateService (Maybe DnsConfig) Source #

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

createService_description :: Lens' CreateService (Maybe Text) Source #

A description for the service.

createService_tags :: Lens' CreateService (Maybe [Tag]) Source #

The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

createService_name :: Lens' CreateService Text Source #

The name that you want to assign to the service.

If you want Cloud Map to create an SRV record when you register an instance and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

  • Start the name with an underscore (_), such as _exampleservice.
  • End the name with ._protocol, such as ._tcp.

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name (for example,

_exampleservice._tcp.example.com).

For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.

Destructuring the Response

data CreateServiceResponse Source #

See: newCreateServiceResponse smart constructor.

Constructors

CreateServiceResponse' 

Fields

Instances

Instances details
Eq CreateServiceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Read CreateServiceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Show CreateServiceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Generic CreateServiceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Associated Types

type Rep CreateServiceResponse :: Type -> Type #

NFData CreateServiceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

Methods

rnf :: CreateServiceResponse -> () #

type Rep CreateServiceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreateService

type Rep CreateServiceResponse = D1 ('MetaData "CreateServiceResponse" "Amazonka.Route53AutoNaming.CreateService" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "CreateServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceInfo)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateServiceResponse Source #

Create a value of CreateServiceResponse 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:service:CreateServiceResponse', createServiceResponse_service - A complex type that contains information about the new service.

$sel:httpStatus:CreateServiceResponse', createServiceResponse_httpStatus - The response's http status code.

Response Lenses

createServiceResponse_service :: Lens' CreateServiceResponse (Maybe ServiceInfo) Source #

A complex type that contains information about the new service.