Class IpamPrefixListResolverRuleRequest

java.lang.Object
software.amazon.awssdk.services.ec2.model.IpamPrefixListResolverRuleRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IpamPrefixListResolverRuleRequest.Builder,IpamPrefixListResolverRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class IpamPrefixListResolverRuleRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamPrefixListResolverRuleRequest.Builder,IpamPrefixListResolverRuleRequest>

Describes a CIDR selection rule to include in a request. This is used when creating or modifying resolver rules.

CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules.

There are three rule types:

  • Static CIDR: A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

  • IPAM pool CIDR: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool).

  • Scope resource CIDR: CIDRs for Amazon Web Services resources like VPCs, subnets, and EIPs within a specific IPAM scope.

Condition availability by resource type:

  • Only 2 of the 3 rule types support conditions - IPAM pool CIDR and Scope resource CIDR. Static CIDR rules cannot have conditions.

    • Condition available for the IPAM pool CIDR resource type:

      • Property:

        • IPAM Pool ID

        • CIDR (like 10.24.34.0/23)

      • Operation: Equals/Not equals

      • Value: The value on which to match the condition

    • Conditions for the Scope resource CIDR resource type:

      • Property:

        • Resource ID: The unique ID of a resource (like vpc-1234567890abcdef0)

        • Resource type (like VPC or Subnet)

        • Resource owner (like 111122223333)

        • Resource region (like us-east-1)

        • Resource tag (like key: name, value: dev-vpc-1)

        • CIDR (like 10.24.34.0/23)

      • Operation: Equals/Not equals

      • Value: The value on which to match the condition

    • When setting conditions for a rule, one or more conditions is required.

See Also:

  • Method Details

    • ruleType

      public final IpamPrefixListResolverRuleType ruleType()

      The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.

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

      Returns:
      The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.
      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.

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

      Returns:
      The type of CIDR selection rule. Valid values include include for selecting CIDRs that match the conditions, and exclude for excluding CIDRs that match the conditions.
      See Also:

    • staticCidr

      public final String staticCidr()

      A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

      Returns:
      A fixed list of CIDRs that do not change (like a manual list replicated across Regions).

    • ipamScopeId

      public final String ipamScopeId()

      The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.

      Returns:
      The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.

    • resourceType

      public final IpamResourceType resourceType()

      For rules of type ipam-resource-cidr, this is the resource type.

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

      Returns:
      For rules of type ipam-resource-cidr, this is the resource type.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      For rules of type ipam-resource-cidr, this is the resource type.

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

      Returns:
      For rules of type ipam-resource-cidr, this is the resource type.
      See Also:

    • hasConditions

      public final boolean hasConditions()
      For responses, this returns true if the service returned a value for the Conditions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • conditions

      public final List<IpamPrefixListResolverRuleConditionRequest> conditions()

      The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.

      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 hasConditions() method.

      Returns:
      The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.

    • toBuilder

      public IpamPrefixListResolverRuleRequest.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<IpamPrefixListResolverRuleRequest.Builder,IpamPrefixListResolverRuleRequest>
      Returns:
      a builder for type T

    • builder

      public static IpamPrefixListResolverRuleRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IpamPrefixListResolverRuleRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.