Class Instance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Instance.Builder,
Instance>
A complex type that contains information about an instance that Cloud Map creates when you submit a
RegisterInstance
request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA string map that contains the following information for the service that you specify inServiceId
:static Instance.Builder
builder()
final String
A unique string that identifies the request and that allows failedRegisterInstance
requests to be retried without the risk of executing the operation twice.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final String
id()
An identifier that you want to associate with the instance.static Class
<? extends Instance.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
An identifier that you want to associate with the instance. Note the following:
-
If the service that's specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
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
andServiceId
, Cloud Map updates the existing DNS records. 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.
- 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 anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
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
andServiceId
, Cloud Map updates the existing DNS records. 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.
-
-
-
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 uniqueCreatorRequestId
string every time you submit aRegisterInstance
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 uniqueCreatorRequestId
string every time you submit aRegisterInstance
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 theisEmpty()
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
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.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
-
If you want Cloud Map to create a 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 AliasTarget->DNSName in the Route 53 API Reference.
Note the following:
-
The configuration for the service that's specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. -
In the service that's specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. -
If the service that's specified by
ServiceId
includesHealthCheckConfig
settings, 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 Amazon Web Services resources other than ELB load balancers.
-
If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_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 useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 anCNAME
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 anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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.
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.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
-
If you want Cloud Map to create a 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 AliasTarget->DNSName in the Route 53 API Reference.
Note the following:
-
The configuration for the service that's specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. -
In the service that's specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. -
If the service that's specified by
ServiceId
includesHealthCheckConfig
settings, 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 Amazon Web Services resources other than ELB load balancers.
-
If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_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 useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 anCNAME
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 anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Instance.Builder,
Instance> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-