java.lang.Object
software.amazon.awssdk.services.route53resolver.model.FirewallRuleGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FirewallRuleGroup.Builder,FirewallRuleGroup>

@Generated("software.amazon.awssdk:codegen") public final class FirewallRuleGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FirewallRuleGroup.Builder,FirewallRuleGroup>

High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call ListFirewallRules.

See Also:
  • Method Details

    • id

      public final String id()

      The ID of the rule group.

      Returns:
      The ID of the rule group.
    • arn

      public final String arn()

      The ARN (Amazon Resource Name) of the rule group.

      Returns:
      The ARN (Amazon Resource Name) of the rule group.
    • name

      public final String name()

      The name of the rule group.

      Returns:
      The name of the rule group.
    • ruleCount

      public final Integer ruleCount()

      The number of rules in the rule group.

      Returns:
      The number of rules in the rule group.
    • status

      public final FirewallRuleGroupStatus status()

      The status of the domain list.

      If the service returns an enum value that is not available in the current SDK version, status will return FirewallRuleGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the domain list.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the domain list.

      If the service returns an enum value that is not available in the current SDK version, status will return FirewallRuleGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the domain list.
      See Also:
    • statusMessage

      public final String statusMessage()

      Additional information about the status of the rule group, if available.

      Returns:
      Additional information about the status of the rule group, if available.
    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

      Returns:
      The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.
    • creatorRequestId

      public final String creatorRequestId()

      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

      Returns:
      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
    • shareStatus

      public final ShareStatus shareStatus()

      Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

      If the service returns an enum value that is not available in the current SDK version, shareStatus will return ShareStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareStatusAsString().

      Returns:
      Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
      See Also:
    • shareStatusAsString

      public final String shareStatusAsString()

      Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

      If the service returns an enum value that is not available in the current SDK version, shareStatus will return ShareStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareStatusAsString().

      Returns:
      Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
      See Also:
    • creationTime

      public final String creationTime()

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

      Returns:
      The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).
    • modificationTime

      public final String modificationTime()

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

      Returns:
      The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).
    • toBuilder

      public FirewallRuleGroup.Builder 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 interface ToCopyableBuilder<FirewallRuleGroup.Builder,FirewallRuleGroup>
      Returns:
      a builder for type T
    • builder

      public static FirewallRuleGroup.Builder builder()
    • serializableBuilderClass

      public static Class<? extends FirewallRuleGroup.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.