Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Route53AutoNaming.RegisterInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data RegisterInstance Source #

See: newRegisterInstance smart constructor.

Constructors

RegisterInstance'

Fields

creatorRequestId :: Maybe Text
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).
serviceId :: Text
The ID of the service that you want to use for settings for the instance.
instanceId :: Text
An identifier that you want to associate with the instance. Note the following:
- If the service that's specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV 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 and ServiceId, 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.
attributes :: HashMap Text Text
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.
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 an A record, an AAAA record, or both.
- In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
- If the service that's specified by ServiceId includes HealthCheckConfig 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 the AWS_INSTANCE attributes.
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 is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_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 use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
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 an CNAME 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 an A record. If the service includes settings for an SRV record, you must specify a value for AWS_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 an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_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.

Instances

Instances details

Eq RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods (==) :: RegisterInstance -> RegisterInstance -> Bool # (/=) :: RegisterInstance -> RegisterInstance -> Bool #
Read RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods readsPrec :: Int -> ReadS RegisterInstance # readList :: ReadS [RegisterInstance] # readPrec :: ReadPrec RegisterInstance # readListPrec :: ReadPrec [RegisterInstance] #
Show RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods showsPrec :: Int -> RegisterInstance -> ShowS # show :: RegisterInstance -> String # showList :: [RegisterInstance] -> ShowS #
Generic RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Associated Types type Rep RegisterInstance :: Type -> Type # Methods from :: RegisterInstance -> Rep RegisterInstance x # to :: Rep RegisterInstance x -> RegisterInstance #
NFData RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods rnf :: RegisterInstance -> () #
Hashable RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods hashWithSalt :: Int -> RegisterInstance -> Int # hash :: RegisterInstance -> Int #
ToJSON RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods toJSON :: RegisterInstance -> Value # toEncoding :: RegisterInstance -> Encoding # toJSONList :: [RegisterInstance] -> Value # toEncodingList :: [RegisterInstance] -> Encoding #
AWSRequest RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Associated Types type AWSResponse RegisterInstance # Methods request :: RegisterInstance -> Request RegisterInstance # response :: MonadResource m => Logger -> Service -> Proxy RegisterInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterInstance))) #
ToHeaders RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods toHeaders :: RegisterInstance -> [Header] #
ToPath RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods toPath :: RegisterInstance -> ByteString #
ToQuery RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods toQuery :: RegisterInstance -> QueryString #
type Rep RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance type Rep RegisterInstance = D1 ('MetaData "RegisterInstance" "Amazonka.Route53AutoNaming.RegisterInstance" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "RegisterInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)))))
type AWSResponse RegisterInstance Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance type AWSResponse RegisterInstance = RegisterInstanceResponse

newRegisterInstance Source #

Arguments

:: Text	`$sel:serviceId:RegisterInstance'`
-> Text	`$sel:instanceId:RegisterInstance'`
-> RegisterInstance

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:

$sel:creatorRequestId: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.

$sel:instanceId: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 an SRV record, the value of InstanceId is automatically included as part of the value for the SRV 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 and ServiceId, 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.

$sel:attributes: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.

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 an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig 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 the AWS_INSTANCE attributes.

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 is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_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 use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

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 an CNAME 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 an A record. If the service includes settings for an SRV record, you must specify a value for AWS_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 an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_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 an SRV record, the value of InstanceId is automatically included as part of the value for the SRV 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 and ServiceId, 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.

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.

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 an A record, an AAAA record, or both.
In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
If the service that's specified by ServiceId includes HealthCheckConfig 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 the AWS_INSTANCE attributes.

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 is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_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 use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

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 an CNAME 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 an A record. If the service includes settings for an SRV record, you must specify a value for AWS_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 an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_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.

Constructors

RegisterInstanceResponse'
Fields operationId :: Maybe Text A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq RegisterInstanceResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods (==) :: RegisterInstanceResponse -> RegisterInstanceResponse -> Bool # (/=) :: RegisterInstanceResponse -> RegisterInstanceResponse -> Bool #
Read RegisterInstanceResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods readsPrec :: Int -> ReadS RegisterInstanceResponse # readList :: ReadS [RegisterInstanceResponse] # readPrec :: ReadPrec RegisterInstanceResponse # readListPrec :: ReadPrec [RegisterInstanceResponse] #
Show RegisterInstanceResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods showsPrec :: Int -> RegisterInstanceResponse -> ShowS # show :: RegisterInstanceResponse -> String # showList :: [RegisterInstanceResponse] -> ShowS #
Generic RegisterInstanceResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Associated Types type Rep RegisterInstanceResponse :: Type -> Type # Methods from :: RegisterInstanceResponse -> Rep RegisterInstanceResponse x # to :: Rep RegisterInstanceResponse x -> RegisterInstanceResponse #
NFData RegisterInstanceResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance Methods rnf :: RegisterInstanceResponse -> () #
type Rep RegisterInstanceResponse Source #
Instance details Defined in Amazonka.Route53AutoNaming.RegisterInstance type Rep RegisterInstanceResponse = D1 ('MetaData "RegisterInstanceResponse" "Amazonka.Route53AutoNaming.RegisterInstance" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "RegisterInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterInstanceResponse'`
-> RegisterInstanceResponse

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.