Class IpamDiscoveredRoute

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

Contains information about a BGP route discovered by IPAM resource discovery.

See Also:

  • Method Details

    • ipamResourceDiscoveryId

      public final String ipamResourceDiscoveryId()

      The ID of the IPAM resource discovery that discovered the route.

      Returns:
      The ID of the IPAM resource discovery that discovered the route.

    • resourceRegion

      public final String resourceRegion()

      The Amazon Web Services Region where the route was discovered.

      Returns:
      The Amazon Web Services Region where the route was discovered.

    • resourceOwnerId

      public final String resourceOwnerId()

      The ID of the resource owner.

      Returns:
      The ID of the resource owner.

    • cidr

      public final String cidr()

      The IP address prefix of the discovered route in CIDR notation.

      Returns:
      The IP address prefix of the discovered route in CIDR notation.

    • asn

      public final String asn()

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

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

    • 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 of the route. 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 of the route. 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 of the route. 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 of the route. 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 for the route.

      Returns:
      The network border group for the route.

    • poolId

      public final String poolId()

      The ID of the BYOIP pool associated with the route.

      Returns:
      The ID of the BYOIP pool associated with the route.

    • ipamPoolId

      public final String ipamPoolId()

      The ID of the IPAM pool associated with the route.

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

    • sampleTime

      public final Instant sampleTime()

      The time when the route was last sampled.

      Returns:
      The time when the route was last sampled.

    • toBuilder

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

    • builder

      public static IpamDiscoveredRoute.Builder builder()

    • serializableBuilderClass

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