Class ResolverEndpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ResolverEndpoint.Builder,
ResolverEndpoint>
In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN (Amazon Resource Name) for the Resolver endpoint.static ResolverEndpoint.Builder
builder()
final String
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).final String
A unique string that identifies the request that created the Resolver endpoint.Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:final String
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries: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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Protocols property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final String
The ID of the VPC that you want to create the Resolver endpoint in.final String
id()
The ID of the Resolver endpoint.final Integer
The number of IP addresses that the Resolver endpoint can use for DNS queries.final String
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).final String
name()
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.final String
The ARN (Amazon Resource Name) for the Outpost.final String
The Amazon EC2 instance type.Protocols used for the endpoint.Protocols used for the endpoint.final ResolverEndpointType
The Resolver endpoint IP address type.final String
The Resolver endpoint IP address type.The ID of one or more security groups that control access to this VPC.static Class
<? extends ResolverEndpoint.Builder> final ResolverEndpointStatus
status()
A code that specifies the current status of the Resolver endpoint.final String
A code that specifies the current status of the Resolver endpoint.final String
A detailed description of the status of the Resolver endpoint.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
The ID of the Resolver endpoint.
- Returns:
- The ID of the Resolver endpoint.
-
creatorRequestId
A unique string that identifies the request that created the Resolver endpoint. The
CreatorRequestId
allows failed requests to be retried without the risk of running the operation twice.- Returns:
- A unique string that identifies the request that created the Resolver endpoint. The
CreatorRequestId
allows failed requests to be retried without the risk of running the operation twice.
-
arn
The ARN (Amazon Resource Name) for the Resolver endpoint.
- Returns:
- The ARN (Amazon Resource Name) for the Resolver endpoint.
-
name
The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
- Returns:
- The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds 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. -
securityGroupIds
The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
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
hasSecurityGroupIds()
method.- Returns:
- The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
-
direction
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
-
INBOUND
: allows DNS queries to your VPC from your network -
OUTBOUND
: allows DNS queries from your VPC to your network
If the service returns an enum value that is not available in the current SDK version,
direction
will returnResolverEndpointDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectionAsString()
.- Returns:
- Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
-
INBOUND
: allows DNS queries to your VPC from your network -
OUTBOUND
: allows DNS queries from your VPC to your network
-
- See Also:
-
-
directionAsString
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
-
INBOUND
: allows DNS queries to your VPC from your network -
OUTBOUND
: allows DNS queries from your VPC to your network
If the service returns an enum value that is not available in the current SDK version,
direction
will returnResolverEndpointDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectionAsString()
.- Returns:
- Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
-
INBOUND
: allows DNS queries to your VPC from your network -
OUTBOUND
: allows DNS queries from your VPC to your network
-
- See Also:
-
-
ipAddressCount
The number of IP addresses that the Resolver endpoint can use for DNS queries.
- Returns:
- The number of IP addresses that the Resolver endpoint can use for DNS queries.
-
hostVPCId
The ID of the VPC that you want to create the Resolver endpoint in.
- Returns:
- The ID of the VPC that you want to create the Resolver endpoint in.
-
status
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
-
CREATING
: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint. -
OPERATIONAL
: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver. -
UPDATING
: Resolver is associating or disassociating one or more network interfaces with this endpoint. -
AUTO_RECOVERING
: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver. -
ACTION_NEEDED
: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status ofACTION_NEEDED
can have a variety of causes. Here are two common causes:-
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
-
The network interface couldn't be created for some reason that's outside the control of Resolver.
-
-
DELETING
: Resolver is deleting this endpoint and the associated network interfaces.
If the service returns an enum value that is not available in the current SDK version,
status
will returnResolverEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- A code that specifies the current status of the Resolver endpoint. Valid values include the
following:
-
CREATING
: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint. -
OPERATIONAL
: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver. -
UPDATING
: Resolver is associating or disassociating one or more network interfaces with this endpoint. -
AUTO_RECOVERING
: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver. -
ACTION_NEEDED
: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status ofACTION_NEEDED
can have a variety of causes. Here are two common causes:-
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
-
The network interface couldn't be created for some reason that's outside the control of Resolver.
-
-
DELETING
: Resolver is deleting this endpoint and the associated network interfaces.
-
- See Also:
-
-
statusAsString
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
-
CREATING
: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint. -
OPERATIONAL
: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver. -
UPDATING
: Resolver is associating or disassociating one or more network interfaces with this endpoint. -
AUTO_RECOVERING
: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver. -
ACTION_NEEDED
: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status ofACTION_NEEDED
can have a variety of causes. Here are two common causes:-
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
-
The network interface couldn't be created for some reason that's outside the control of Resolver.
-
-
DELETING
: Resolver is deleting this endpoint and the associated network interfaces.
If the service returns an enum value that is not available in the current SDK version,
status
will returnResolverEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- A code that specifies the current status of the Resolver endpoint. Valid values include the
following:
-
CREATING
: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint. -
OPERATIONAL
: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver. -
UPDATING
: Resolver is associating or disassociating one or more network interfaces with this endpoint. -
AUTO_RECOVERING
: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver. -
ACTION_NEEDED
: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status ofACTION_NEEDED
can have a variety of causes. Here are two common causes:-
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
-
The network interface couldn't be created for some reason that's outside the control of Resolver.
-
-
DELETING
: Resolver is deleting this endpoint and the associated network interfaces.
-
- See Also:
-
-
statusMessage
A detailed description of the status of the Resolver endpoint.
- Returns:
- A detailed description of the status of the Resolver endpoint.
-
creationTime
The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
- Returns:
- The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
-
modificationTime
The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
- Returns:
- The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
-
outpostArn
The ARN (Amazon Resource Name) for the Outpost.
- Returns:
- The ARN (Amazon Resource Name) for the Outpost.
-
preferredInstanceType
The Amazon EC2 instance type.
- Returns:
- The Amazon EC2 instance type.
-
resolverEndpointType
The Resolver endpoint IP address type.
If the service returns an enum value that is not available in the current SDK version,
resolverEndpointType
will returnResolverEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresolverEndpointTypeAsString()
.- Returns:
- The Resolver endpoint IP address type.
- See Also:
-
resolverEndpointTypeAsString
The Resolver endpoint IP address type.
If the service returns an enum value that is not available in the current SDK version,
resolverEndpointType
will returnResolverEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresolverEndpointTypeAsString()
.- Returns:
- The Resolver endpoint IP address type.
- See Also:
-
protocols
Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 and DoH-FIPS in combination.
-
Do53 alone.
-
DoH alone.
-
DoH-FIPS alone.
-
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 alone.
-
DoH alone.
-
None, which is treated as Do53.
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
hasProtocols()
method.- Returns:
- Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 and DoH-FIPS in combination.
-
Do53 alone.
-
DoH alone.
-
DoH-FIPS alone.
-
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 alone.
-
DoH alone.
-
None, which is treated as Do53.
-
-
-
hasProtocols
public final boolean hasProtocols()For responses, this returns true if the service returned a value for the Protocols 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. -
protocolsAsStrings
Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 and DoH-FIPS in combination.
-
Do53 alone.
-
DoH alone.
-
DoH-FIPS alone.
-
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 alone.
-
DoH alone.
-
None, which is treated as Do53.
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
hasProtocols()
method.- Returns:
- Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 and DoH-FIPS in combination.
-
Do53 alone.
-
DoH alone.
-
DoH-FIPS alone.
-
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
-
Do53 and DoH in combination.
-
Do53 alone.
-
DoH alone.
-
None, which is treated as Do53.
-
-
-
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<ResolverEndpoint.Builder,
ResolverEndpoint> - 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
-