java.lang.Object
- software.amazon.awssdk.services.ec2.model.IpamPrefixListResolverRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IpamPrefixListResolverRule.Builder,IpamPrefixListResolverRule>
```
@Generated("software.amazon.awssdk:codegen")
public final class IpamPrefixListResolverRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IpamPrefixListResolverRule.Builder,IpamPrefixListResolverRule>
```
Describes a CIDR selection rule.

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface IpamPrefixListResolverRule.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static IpamPrefixListResolverRule.Builder`	`builder()`
`List<IpamPrefixListResolverRuleCondition>`	`conditions()`	The conditions that determine which CIDRs are selected by this rule.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasConditions()`	For responses, this returns true if the service returned a value for the Conditions property.
`int`	`hashCode()`
`String`	`ipamScopeId()`	The ID of the IPAM scope from which to select CIDRs.
`IpamResourceType`	`resourceType()`	For rules of type `ipam-resource-cidr`, this is the resource type.
`String`	`resourceTypeAsString()`	For rules of type `ipam-resource-cidr`, this is the resource type.
`IpamPrefixListResolverRuleType`	`ruleType()`	The type of CIDR selection rule.
`String`	`ruleTypeAsString()`	The type of CIDR selection rule.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends IpamPrefixListResolverRule.Builder>`	`serializableBuilderClass()`
`String`	`staticCidr()`	A fixed list of CIDRs that do not change (like a manual list replicated across Regions).
`IpamPrefixListResolverRule.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    IpamPrefixListResolverRuleType
  - 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:
    
    IpamPrefixListResolverRuleType
  - 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:
    
    IpamResourceType
  - 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:
    
    IpamResourceType
  - 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<IpamPrefixListResolverRuleCondition> 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 IpamPrefixListResolverRule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IpamPrefixListResolverRule.Builder,IpamPrefixListResolverRule>
  - builder
```
public static IpamPrefixListResolverRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends IpamPrefixListResolverRule.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class IpamPrefixListResolverRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ruleType

ruleTypeAsString

staticCidr

ipamScopeId

resourceType

resourceTypeAsString

hasConditions

conditions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField