java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.servicediscovery.model.ServiceDiscoveryRequest
    - - software.amazon.awssdk.services.servicediscovery.model.RegisterInstanceRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RegisterInstanceRequest.Builder,RegisterInstanceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RegisterInstanceRequest
extends ServiceDiscoveryRequest
implements ToCopyableBuilder<RegisterInstanceRequest.Builder,RegisterInstanceRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RegisterInstanceRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`attributes()`	A string map that contains the following information for the service that you specify in `ServiceId`:
`static RegisterInstanceRequest.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()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`String`	`instanceId()`	An identifier that you want to associate with the instance.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterInstanceRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceId()`	The ID of the service that you want to use for settings for the instance.
`RegisterInstanceRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - serviceId
```
public final String serviceId()
```
    The ID of the service that you want to use for settings for the instance.
    
    Returns:
    
    The ID of the service that you want to use for settings for the instance.
  - instanceId
```
public final 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.
    Returns:
    
    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.
  - 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()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.
    
    The following are the supported attribute keys.
    
    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.
    
    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.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    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.
    
    Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.
    
    The following are the supported attribute keys.
    
    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.
    
    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.
    
    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.
  - toBuilder
```
public RegisterInstanceRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterInstanceRequest.Builder,RegisterInstanceRequest>
    
    Specified by:
    
    toBuilder in class ServiceDiscoveryRequest
  - builder
```
public static RegisterInstanceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterInstanceRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class RegisterInstanceRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

serviceId

instanceId

creatorRequestId

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField