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 |
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's specified
by
ServiceId
, a record is created or updated in the hosted zone that's 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 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 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 RegisterInstance = RegisterInstance' {}
- newRegisterInstance :: Text -> Text -> RegisterInstance
- registerInstance_creatorRequestId :: Lens' RegisterInstance (Maybe Text)
- registerInstance_serviceId :: Lens' RegisterInstance Text
- registerInstance_instanceId :: Lens' RegisterInstance Text
- registerInstance_attributes :: Lens' RegisterInstance (HashMap Text Text)
- data RegisterInstanceResponse = RegisterInstanceResponse' {
- operationId :: Maybe Text
- httpStatus :: Int
- newRegisterInstanceResponse :: Int -> RegisterInstanceResponse
- registerInstanceResponse_operationId :: Lens' RegisterInstanceResponse (Maybe Text)
- registerInstanceResponse_httpStatus :: Lens' RegisterInstanceResponse Int
Creating a Request
data RegisterInstance Source #
See: newRegisterInstance
smart constructor.
RegisterInstance' | |
|
Instances
Create a value of RegisterInstance
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:
RegisterInstance
, registerInstance_creatorRequestId
- 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).
$sel:serviceId:RegisterInstance'
, registerInstance_serviceId
- The ID of the service that you want to use for settings for the
instance.
RegisterInstance
, registerInstance_instanceId
- An identifier that you want to associate with the instance. Note the
following:
- If the service that's specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
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's unique among instances that you register by using the same service.
If you specify an existing
InstanceId
andServiceId
, Cloud Map updates the existing DNS records, if any. If there's also an existing health check, 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.
Do not include sensitive information in InstanceId
if the namespace is
discoverable by public DNS queries and any Type
member of DnsRecord
for the service contains SRV
because the InstanceId
is discoverable
by public DNS queries.
RegisterInstance
, registerInstance_attributes
- 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.
Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
- If you want 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's associated with the load balancer. For
information about how to get the DNS name, see "DNSName" in the
topic
AliasTarget
in the Route 53 API Reference.
Note the following:
- The configuration for the service that's specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. - In the service that's specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. - If the service that's specified by
ServiceId
includesHealthCheckConfig
settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record. - Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
- If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_INSTANCE
attributes.
- The configuration for the service that's specified by
- AWS_EC2_INSTANCE_ID
- HTTP namespaces only. The Amazon EC2 instance ID for the instance.
If the
AWS_EC2_INSTANCE_ID
attribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS
. When theAWS_EC2_INSTANCE_ID
attribute is specified, then theAWS_INSTANCE_IPV4
attribute will be filled out with the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
- If the service configuration includes
HealthCheckCustomConfig
, you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 anCNAME
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 anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 or a Route 53 health check 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. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.
Request Lenses
registerInstance_creatorRequestId :: Lens' RegisterInstance (Maybe Text) Source #
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).
registerInstance_serviceId :: Lens' RegisterInstance Text Source #
The ID of the service that you want to use for settings for the instance.
registerInstance_instanceId :: Lens' RegisterInstance Text Source #
An identifier that you want to associate with the instance. Note the following:
- If the service that's specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
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's unique among instances that you register by using the same service.
If you specify an existing
InstanceId
andServiceId
, Cloud Map updates the existing DNS records, if any. If there's also an existing health check, 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.
Do not include sensitive information in InstanceId
if the namespace is
discoverable by public DNS queries and any Type
member of DnsRecord
for the service contains SRV
because the InstanceId
is discoverable
by public DNS queries.
registerInstance_attributes :: Lens' RegisterInstance (HashMap Text Text) Source #
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.
Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
- If you want 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's associated with the load balancer. For
information about how to get the DNS name, see "DNSName" in the
topic
AliasTarget
in the Route 53 API Reference.
Note the following:
- The configuration for the service that's specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. - In the service that's specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. - If the service that's specified by
ServiceId
includesHealthCheckConfig
settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record. - Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
- If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_INSTANCE
attributes.
- The configuration for the service that's specified by
- AWS_EC2_INSTANCE_ID
- HTTP namespaces only. The Amazon EC2 instance ID for the instance.
If the
AWS_EC2_INSTANCE_ID
attribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS
. When theAWS_EC2_INSTANCE_ID
attribute is specified, then theAWS_INSTANCE_IPV4
attribute will be filled out with the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
- If the service configuration includes
HealthCheckCustomConfig
, you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 anCNAME
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 anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 or a Route 53 health check 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. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.
Destructuring the Response
data RegisterInstanceResponse Source #
See: newRegisterInstanceResponse
smart constructor.
RegisterInstanceResponse' | |
|
Instances
newRegisterInstanceResponse Source #
Create a value of RegisterInstanceResponse
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:operationId:RegisterInstanceResponse'
, registerInstanceResponse_operationId
- A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:RegisterInstanceResponse'
, registerInstanceResponse_httpStatus
- The response's http status code.
Response Lenses
registerInstanceResponse_operationId :: Lens' RegisterInstanceResponse (Maybe Text) Source #
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
registerInstanceResponse_httpStatus :: Lens' RegisterInstanceResponse Int Source #
The response's http status code.