Class IpamRouteProtectionFinding

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

Contains information about a route protection finding, including the RPKI validation status of a BYOIP route announcement.

See Also:

  • Method Details

    • resourceOwnerId

      public final String resourceOwnerId()

      The ID of the resource owner.

      Returns:
      The ID of the resource owner.

    • resourceRegion

      public final String resourceRegion()

      The Amazon Web Services Region of the resource.

      Returns:
      The Amazon Web Services Region of the resource.

    • ipamPoolId

      public final String ipamPoolId()

      The ID of the IPAM pool associated with the finding.

      Returns:
      The ID of the IPAM pool associated with the finding.

    • cidr

      public final String cidr()

      The IP address prefix in CIDR notation.

      Returns:
      The IP address prefix in CIDR notation.

    • state

      public final IpamByoipCidrState state()

      The state of the BYOIP CIDR. Possible values:

      • advertised - The CIDR is being advertised.

      • deprovisioned - The CIDR has been deprovisioned.

      • failed-deprovision - Deprovisioning failed.

      • failed-provision - Provisioning failed.

      • pending-deprovision - Deprovisioning is in progress.

      • pending-provision - Provisioning is in progress.

      • provisioned - The CIDR is provisioned.

      • provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.

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

      Returns:
      The state of the BYOIP CIDR. Possible values:

      • advertised - The CIDR is being advertised.

      • deprovisioned - The CIDR has been deprovisioned.

      • failed-deprovision - Deprovisioning failed.

      • failed-provision - Provisioning failed.

      • pending-deprovision - Deprovisioning is in progress.

      • pending-provision - Provisioning is in progress.

      • provisioned - The CIDR is provisioned.

      • provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the BYOIP CIDR. Possible values:

      • advertised - The CIDR is being advertised.

      • deprovisioned - The CIDR has been deprovisioned.

      • failed-deprovision - Deprovisioning failed.

      • failed-provision - Provisioning failed.

      • pending-deprovision - Deprovisioning is in progress.

      • pending-provision - Provisioning is in progress.

      • provisioned - The CIDR is provisioned.

      • provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.

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

      Returns:
      The state of the BYOIP CIDR. Possible values:

      • advertised - The CIDR is being advertised.

      • deprovisioned - The CIDR has been deprovisioned.

      • failed-deprovision - Deprovisioning failed.

      • failed-provision - Provisioning failed.

      • pending-deprovision - Deprovisioning is in progress.

      • pending-provision - Provisioning is in progress.

      • provisioned - The CIDR is provisioned.

      • provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.

      See Also:

    • advertisementType

      public final IpamByoipAdvertisementType advertisementType()

      The advertisement type. Possible values:

      • regional - The IP address is advertised from a single location (regional services such as Amazon EC2).

      • global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).

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

      Returns:
      The advertisement type. Possible values:

      • regional - The IP address is advertised from a single location (regional services such as Amazon EC2).

      • global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).

      See Also:

    • advertisementTypeAsString

      public final String advertisementTypeAsString()

      The advertisement type. Possible values:

      • regional - The IP address is advertised from a single location (regional services such as Amazon EC2).

      • global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).

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

      Returns:
      The advertisement type. Possible values:

      • regional - The IP address is advertised from a single location (regional services such as Amazon EC2).

      • global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).

      See Also:

    • networkBorderGroup

      public final String networkBorderGroup()

      The network border group.

      Returns:
      The network border group.

    • poolId

      public final String poolId()

      The ID of the BYOIP pool.

      Returns:
      The ID of the BYOIP pool.

    • asn

      public final String asn()

      The Autonomous System Number (ASN) that originates the route.

      Returns:
      The Autonomous System Number (ASN) that originates the route.

    • rpkiStatus

      public final IpamRpkiStatus rpkiStatus()

      The RPKI validation status of the route. Possible values:

      • valid - The route has a matching ROA that covers the prefix and origin ASN.

      • invalid - The route has a ROA for the prefix, but the origin ASN or prefix length does not match.

      • unknown - No ROA exists for the prefix, so RPKI validation cannot be performed.

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

      Returns:
      The RPKI validation status of the route. Possible values:

      • valid - The route has a matching ROA that covers the prefix and origin ASN.

      • invalid - The route has a ROA for the prefix, but the origin ASN or prefix length does not match.

      • unknown - No ROA exists for the prefix, so RPKI validation cannot be performed.

      See Also:

    • rpkiStatusAsString

      public final String rpkiStatusAsString()

      The RPKI validation status of the route. Possible values:

      • valid - The route has a matching ROA that covers the prefix and origin ASN.

      • invalid - The route has a ROA for the prefix, but the origin ASN or prefix length does not match.

      • unknown - No ROA exists for the prefix, so RPKI validation cannot be performed.

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

      Returns:
      The RPKI validation status of the route. Possible values:

      • valid - The route has a matching ROA that covers the prefix and origin ASN.

      • invalid - The route has a ROA for the prefix, but the origin ASN or prefix length does not match.

      • unknown - No ROA exists for the prefix, so RPKI validation cannot be performed.

      See Also:

    • rpkiStrength

      public final IpamRpkiStrength rpkiStrength()

      The RPKI enforcement strength for the route. Possible values:

      • strict - Invalid routes are rejected.

      • permissive - Invalid routes are accepted but flagged.

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

      Returns:
      The RPKI enforcement strength for the route. Possible values:

      • strict - Invalid routes are rejected.

      • permissive - Invalid routes are accepted but flagged.

      See Also:

    • rpkiStrengthAsString

      public final String rpkiStrengthAsString()

      The RPKI enforcement strength for the route. Possible values:

      • strict - Invalid routes are rejected.

      • permissive - Invalid routes are accepted but flagged.

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

      Returns:
      The RPKI enforcement strength for the route. Possible values:

      • strict - Invalid routes are rejected.

      • permissive - Invalid routes are accepted but flagged.

      See Also:

    • hasRoas

      public final boolean hasRoas()
      For responses, this returns true if the service returned a value for the Roas 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.

    • roas

      public final List<IpamRouteOriginAuthorization> roas()

      The Route Origin Authorizations (ROAs) that cover the prefix.

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

      Returns:
      The Route Origin Authorizations (ROAs) that cover the prefix.

    • hasRouteOverlaps

      public final boolean hasRouteOverlaps()
      For responses, this returns true if the service returned a value for the RouteOverlaps 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.

    • routeOverlaps

      public final List<IpamRouteOverlap> routeOverlaps()

      The overlapping routes detected for this prefix.

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

      Returns:
      The overlapping routes detected for this prefix.

    • sampleTime

      public final Instant sampleTime()

      The time when the route was last sampled.

      Returns:
      The time when the route was last sampled.

    • roaSampleTime

      public final Instant roaSampleTime()

      The time when the ROA data was last sampled.

      Returns:
      The time when the ROA data was last sampled.

    • toBuilder

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

    • builder

      public static IpamRouteProtectionFinding.Builder builder()

    • serializableBuilderClass

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