Instance (AWS Java SDK :: Services :: Amazon Route 53 Auto Naming 2.16.60 API)

java.lang.Object
- software.amazon.awssdk.services.servicediscovery.model.Instance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Instance.Builder,Instance>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Instance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Instance.Builder,Instance>
```
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Instance.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Instance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`attributes()` A string map that contains the following information for the service that you specify in `ServiceId`:
`static Instance.Builder`	`builder()`
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`id()` An identifier that you want to associate with the instance.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Instance.Builder>`	`serializableBuilderClass()`
`Instance.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final 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.
    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.
  - creatorRequestId
```
public final 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.
    
    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.
  - hasAttributes
```
public final boolean hasAttributes()
```
    Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attributes
```
public final 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 AliasTarget->DNSName in the Route 53 API Reference.
    
    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 creates 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_EC2_INSTANCE_ID
    
    HTTP namespaces only. The Amazon EC2 instance ID for the instance. The AWS_INSTANCE_IPV4 attribute contains 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttributes() to see if a value was sent in this field.
    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 AliasTarget->DNSName in the Route 53 API Reference.
    
    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 creates 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_EC2_INSTANCE_ID
    
    HTTP namespaces only. The Amazon EC2 instance ID for the instance. The AWS_INSTANCE_IPV4 attribute contains 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.
  - toBuilder
```
public Instance.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>
  - builder
```
public static Instance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Instance.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

creatorRequestId

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields