Class CreateResolverRuleRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateResolverRuleRequest.Builder,
CreateResolverRuleRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.final String
DNS queries for this domain name are forwarded to the IP addresses that you specify inTargetIps
.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the TargetIps property.final String
name()
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.final String
The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify inTargetIps
.final RuleTypeOption
ruleType()
When you want to forward DNS queries for specified domain name to resolvers on your network, specifyFORWARD
.final String
When you want to forward DNS queries for specified domain name to resolvers on your network, specifyFORWARD
.static Class
<? extends CreateResolverRuleRequest.Builder> tags()
A list of the tag keys and values that you want to associate with the endpoint.final List
<TargetAddress> The IPs that you want Resolver to forward DNS queries to.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
creatorRequestId
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
CreatorRequestId
can be any unique string, for example, a date/time stamp.- Returns:
- A unique string that identifies the request and that allows failed requests to be retried without the
risk of running the operation twice.
CreatorRequestId
can be any unique string, for example, a date/time stamp.
-
name
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
- Returns:
- A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
-
ruleType
When you want to forward DNS queries for specified domain name to resolvers on your network, specify
FORWARD
.When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify
SYSTEM
.For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
FORWARD
forRuleType
. To then have Resolver process queries for apex.example.com, you create a rule and specifySYSTEM
forRuleType
.Currently, only Resolver can create rules that have a value of
RECURSIVE
forRuleType
.If the service returns an enum value that is not available in the current SDK version,
ruleType
will returnRuleTypeOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruleTypeAsString()
.- Returns:
- When you want to forward DNS queries for specified domain name to resolvers on your network, specify
FORWARD
.When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify
SYSTEM
.For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
FORWARD
forRuleType
. To then have Resolver process queries for apex.example.com, you create a rule and specifySYSTEM
forRuleType
.Currently, only Resolver can create rules that have a value of
RECURSIVE
forRuleType
. - See Also:
-
ruleTypeAsString
When you want to forward DNS queries for specified domain name to resolvers on your network, specify
FORWARD
.When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify
SYSTEM
.For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
FORWARD
forRuleType
. To then have Resolver process queries for apex.example.com, you create a rule and specifySYSTEM
forRuleType
.Currently, only Resolver can create rules that have a value of
RECURSIVE
forRuleType
.If the service returns an enum value that is not available in the current SDK version,
ruleType
will returnRuleTypeOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruleTypeAsString()
.- Returns:
- When you want to forward DNS queries for specified domain name to resolvers on your network, specify
FORWARD
.When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify
SYSTEM
.For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify
FORWARD
forRuleType
. To then have Resolver process queries for apex.example.com, you create a rule and specifySYSTEM
forRuleType
.Currently, only Resolver can create rules that have a value of
RECURSIVE
forRuleType
. - See Also:
-
domainName
DNS queries for this domain name are forwarded to the IP addresses that you specify in
TargetIps
. If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).- Returns:
- DNS queries for this domain name are forwarded to the IP addresses that you specify in
TargetIps
. If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).
-
hasTargetIps
public final boolean hasTargetIps()For responses, this returns true if the service returned a value for the TargetIps 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. -
targetIps
The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.
TargetIps
is available only when the value ofRule type
isFORWARD
.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
hasTargetIps()
method.- Returns:
- The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses
but not both in the same rule. Separate IP addresses with a space.
TargetIps
is available only when the value ofRule type
isFORWARD
.
-
resolverEndpointId
The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in
TargetIps
.- Returns:
- The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses
that you specify in
TargetIps
.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
A list of the tag keys and values that you want to associate with the endpoint.
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
hasTags()
method.- Returns:
- A list of the tag keys and values that you want to associate with the endpoint.
-
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<CreateResolverRuleRequest.Builder,
CreateResolverRuleRequest> - Specified by:
toBuilder
in classRoute53ResolverRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-