| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
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
AandAAAASRV
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
- data CreateService = CreateService' {}
- newCreateService :: Text -> CreateService
- createService_creatorRequestId :: Lens' CreateService (Maybe Text)
- createService_description :: Lens' CreateService (Maybe Text)
- createService_dnsConfig :: Lens' CreateService (Maybe DnsConfig)
- createService_healthCheckConfig :: Lens' CreateService (Maybe HealthCheckConfig)
- createService_healthCheckCustomConfig :: Lens' CreateService (Maybe HealthCheckCustomConfig)
- createService_namespaceId :: Lens' CreateService (Maybe Text)
- createService_tags :: Lens' CreateService (Maybe [Tag])
- createService_type :: Lens' CreateService (Maybe ServiceTypeOption)
- createService_name :: Lens' CreateService Text
- data CreateServiceResponse = CreateServiceResponse' {
- service :: Maybe ServiceInfo
- httpStatus :: Int
- newCreateServiceResponse :: Int -> CreateServiceResponse
- createServiceResponse_service :: Lens' CreateServiceResponse (Maybe ServiceInfo)
- createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int
Creating a Request
data CreateService Source #
See: newCreateService smart constructor.
Constructors
| CreateService' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateService |
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:
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).
CreateService, createService_description - A description for the service.
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.
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.
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.
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: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.
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.
CreateService, createService_name - The name that you want to assign to the service.
Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.
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_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_description :: Lens' CreateService (Maybe Text) Source #
A description for the service.
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_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_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_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_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_name :: Lens' CreateService Text Source #
The name that you want to assign to the service.
Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.
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
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.
createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int Source #
The response's http status code.