Instance (AWS Java SDK for Amazon Route 53 Auto Naming 1.11.534 API)

java.lang.Object
- com.amazonaws.services.servicediscovery.model.Instance

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Instance
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Instance()

Constructors
Constructor and Description
`Instance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instance`	`addAttributesEntry(String key, String value)`
`Instance`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`Instance`	`clone()`
`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`	`getId()` An identifier that you want to associate with the instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`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`	`setId(String id)` An identifier that you want to associate with the instance.
`String`	`toString()` Returns a string representation of this object.
`Instance`	`withAttributes(Map<String,String> attributes)` A string map that contains the following information for the service that you specify in `ServiceId`:
`Instance`	`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.
`Instance`	`withId(String id)` An identifier that you want to associate with the instance.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Instance
```
public Instance()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    An identifier that you want to associate with the instance. Note the following:
    - If the service that is 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 is unique among instances that you register by using the same service.
    - If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS 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.
    Parameters:
    id - An identifier that you want to associate with the instance. Note the following:
    
    If the service that is 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 is unique among instances that you register by using the same service.
    
    If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS 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.
  - getId
```
public String getId()
```
    An identifier that you want to associate with the instance. Note the following:
    - If the service that is 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 is unique among instances that you register by using the same service.
    - If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS 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.
    Returns:
    An identifier that you want to associate with the instance. Note the following:
    
    If the service that is 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 is unique among instances that you register by using the same service.
    
    If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS 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.
  - withId
```
public Instance withId(String id)
```
    An identifier that you want to associate with the instance. Note the following:
    - If the service that is 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 is unique among instances that you register by using the same service.
    - If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS 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.
    Parameters:
    id - An identifier that you want to associate with the instance. Note the following:
    
    If the service that is 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 is unique among instances that you register by using the same service.
    
    If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatorRequestId
```
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.
    
    Parameters:
    
    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.
  - getCreatorRequestId
```
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.
    
    Returns:
    
    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.
  - withCreatorRequestId
```
public Instance 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
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.
    Supported attribute keys include the following:
    
    AWS_ALIAS_DNS_NAME
    
    If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
    
    Note the following:
    
    The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
    
    In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
    
    If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.
    
    Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
    
    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
    
    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 when you created the service.
    Returns:
    
    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 AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
    
    Note the following:
    
    The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
    
    In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
    
    If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.
    
    Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
    
    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
    
    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 when you created the service.
  setAttributes
  
  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.
  
  Supported attribute keys include the following:
  
  AWS_ALIAS_DNS_NAME
  
  If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
  
  Note the following:
  
  The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
  
  In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
  
  If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.
  
  Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
  
  If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
  
  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 when you created the service.
  
  Parameters:
  
  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 AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
  
  Note the following:
  
  The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
  
  In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
  
  If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.
  
  Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
  
  If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
  
  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 when you created the service.
  
  withAttributes
  
  public Instance 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.
  
  Supported attribute keys include the following:
  
  AWS_ALIAS_DNS_NAME
  
  If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
  
  Note the following:
  
  The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
  
  In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
  
  If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.
  
  Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
  
  If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
  
  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 when you created the service.
  
  Parameters:
  
  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 AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
  
  Note the following:
  
  The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.
  
  In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
  
  If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.
  
  Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
  
  If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.
  
  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 when you created the service.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  addAttributesEntry
  
  public Instance addAttributesEntry(String key, String value)
  
  clearAttributesEntries
  
  public Instance clearAttributesEntries()
  
  Removes all the entries added into Attributes.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  toString
  
  public String toString()
  
  Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  A string representation of this object.
  
  See Also:
  
  Object.toString()
  
  equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
  
  hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
  
  clone
  
  public Instance clone()
  
  Overrides:
  
  clone in class Object
  
  marshall
  
  public void marshall(ProtocolMarshaller protocolMarshaller)
  
  Specified by:
  
  marshall in interface StructuredPojo

Class Instance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Instance

Method Detail

setId

getId

withId

setCreatorRequestId

getCreatorRequestId

withCreatorRequestId

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

toString

equals

hashCode

clone

marshall