Package software.amazon.awssdk.services.route53resolver.model

Interface ResolverRule.Builder

    • Method Detail

      • id

        ResolverRule.Builder id​(String id)

        The ID that Resolver assigned to the Resolver rule when you created it.

        Parameters:
        id - The ID that Resolver assigned to the Resolver rule when you created it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creatorRequestId

        ResolverRule.Builder creatorRequestId​(String creatorRequestId)

        A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.

        Parameters:
        creatorRequestId - A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        ResolverRule.Builder arn​(String arn)

        The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

        Parameters:
        arn - The ARN (Amazon Resource Name) for the Resolver rule specified by Id.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainName

        ResolverRule.Builder domainName​(String domainName)

        DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

        Parameters:
        domainName - DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ResolverRule.Builder status​(String status)

        A code that specifies the current status of the Resolver rule.

        Parameters:
        status - A code that specifies the current status of the Resolver rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ResolverRuleStatus, ResolverRuleStatus

      • statusMessage

        ResolverRule.Builder statusMessage​(String statusMessage)

        A detailed description of the status of a Resolver rule.

        Parameters:
        statusMessage - A detailed description of the status of a Resolver rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ruleType

        ResolverRule.Builder ruleType​(String 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 for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

        Parameters:
        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 for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleTypeOption, RuleTypeOption

      • ruleType

        ResolverRule.Builder ruleType​(RuleTypeOption 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 for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

        Parameters:
        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 for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

        Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RuleTypeOption, RuleTypeOption

      • name

        ResolverRule.Builder name​(String name)

        The name for the Resolver rule, which you specified when you created the Resolver rule.

        Parameters:
        name - The name for the Resolver rule, which you specified when you created the Resolver rule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetIps

        ResolverRule.Builder targetIps​(Collection<TargetAddress> targetIps)

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.

        Parameters:
        targetIps - An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetIps

        ResolverRule.Builder targetIps​(TargetAddress... targetIps)

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.

        Parameters:
        targetIps - An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetIps

        ResolverRule.Builder targetIps​(Consumer<TargetAddress.Builder>... targetIps)

        An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.

        This is a convenience method that creates an instance of the TargetAddress.Builder avoiding the need to create one manually via TargetAddress.builder() .

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #targetIps(List).

        Parameters:
        targetIps - a consumer that will call methods on TargetAddress.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #targetIps(java.util.Collection)

      • resolverEndpointId

        ResolverRule.Builder resolverEndpointId​(String resolverEndpointId)

        The ID of the endpoint that the rule is associated with.

        Parameters:
        resolverEndpointId - The ID of the endpoint that the rule is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownerId

        ResolverRule.Builder ownerId​(String ownerId)

        When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

        Parameters:
        ownerId - When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shareStatus

        ResolverRule.Builder shareStatus​(String shareStatus)

        Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

        Parameters:
        shareStatus - Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShareStatus, ShareStatus

      • shareStatus

        ResolverRule.Builder shareStatus​(ShareStatus shareStatus)

        Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

        Parameters:
        shareStatus - Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShareStatus, ShareStatus

      • creationTime

        ResolverRule.Builder creationTime​(String creationTime)

        The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

        Parameters:
        creationTime - The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modificationTime

        ResolverRule.Builder modificationTime​(String modificationTime)

        The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

        Parameters:
        modificationTime - The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.