@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RegisterInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
RegisterInstanceRequest() |
| Modifier and Type | Method and Description |
|---|---|
RegisterInstanceRequest |
addAttributesEntry(String key,
String value)
Add a single Attributes entry
|
RegisterInstanceRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
RegisterInstanceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
A string map that contains the following information for the service that you specify in
ServiceId: |
String |
getCreatorRequestId()
A unique string that identifies the request and that allows failed
RegisterInstance requests to be
retried without the risk of executing the operation twice. |
String |
getInstanceId()
An identifier that you want to associate with the instance.
|
String |
getServiceId()
The ID of the service that you want to use for settings for the instance.
|
int |
hashCode() |
void |
setAttributes(Map<String,String> attributes)
A string map that contains the following information for the service that you specify in
ServiceId: |
void |
setCreatorRequestId(String 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. |
void |
setInstanceId(String instanceId)
An identifier that you want to associate with the instance.
|
void |
setServiceId(String serviceId)
The ID of the service that you want to use for settings for the instance.
|
String |
toString()
Returns a string representation of this object.
|
RegisterInstanceRequest |
withAttributes(Map<String,String> attributes)
A string map that contains the following information for the service that you specify in
ServiceId: |
RegisterInstanceRequest |
withCreatorRequestId(String 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. |
RegisterInstanceRequest |
withInstanceId(String instanceId)
An identifier that you want to associate with the instance.
|
RegisterInstanceRequest |
withServiceId(String serviceId)
The ID of the service that you want to use for settings for the instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setServiceId(String serviceId)
The ID of the service that you want to use for settings for the instance.
serviceId - The ID of the service that you want to use for settings for the instance.public String getServiceId()
The ID of the service that you want to use for settings for the instance.
public RegisterInstanceRequest withServiceId(String serviceId)
The ID of the service that you want to use for settings for the instance.
serviceId - The ID of the service that you want to use for settings for the instance.public void setInstanceId(String 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.
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.
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.
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.
public String getInstanceId()
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.
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.
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.
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.
public RegisterInstanceRequest withInstanceId(String 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.
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.
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.
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.
public void setCreatorRequestId(String 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).
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).public String getCreatorRequestId()
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 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).public RegisterInstanceRequest withCreatorRequestId(String 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).
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).public Map<String,String> getAttributes()
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.
The following are the supported attribute keys.
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.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
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.
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.
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.
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.
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.
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.
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.
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.
The following are the supported attribute keys.
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.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
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.
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.
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.
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.
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.
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.
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.
public void setAttributes(Map<String,String> 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.
The following are the supported attribute keys.
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.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
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.
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.
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.
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.
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.
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.
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.
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.
The following are the supported attribute keys.
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.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
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.
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.
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.
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.
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.
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.
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.
public RegisterInstanceRequest withAttributes(Map<String,String> 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.
The following are the supported attribute keys.
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.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
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.
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.
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.
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.
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.
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.
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.
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.
The following are the supported attribute keys.
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.
Cloud Map 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.
The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.
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.
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.
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.
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.
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.
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.
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.
public RegisterInstanceRequest addAttributesEntry(String key, String value)
public RegisterInstanceRequest clearAttributesEntries()
public String toString()
toString in class ObjectObject.toString()public RegisterInstanceRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()