Package software.amazon.awssdk.services.ec2.model

Class ProvisionByoipCidrRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ProvisionByoipCidrRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>
@Generated("software.amazon.awssdk:codegen") public final class ProvisionByoipCidrRequest extends Ec2Request implements ToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>

  • Method Details

    • cidr

      public final String cidr()

      The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

      Returns:
      The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.

    • cidrAuthorizationContext

      public final CidrAuthorizationContext cidrAuthorizationContext()

      A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

      Returns:
      A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

    • publiclyAdvertisable

      public final Boolean publiclyAdvertisable()

      (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

      Default: true

      Returns:
      (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

      Default: true

    • description

      public final String description()

      A description for the address range and the address pool.

      Returns:
      A description for the address range and the address pool.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • hasPoolTagSpecifications

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

    • poolTagSpecifications

      public final List<TagSpecification> poolTagSpecifications()

      The tags to apply to the address pool.

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

      Returns:
      The tags to apply to the address pool.

    • multiRegion

      public final Boolean multiRegion()

      Reserved.

      Returns:
      Reserved.

    • networkBorderGroup

      public final String networkBorderGroup()

      If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

      Returns:
      If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

    • toBuilder

      public ProvisionByoipCidrRequest.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<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ProvisionByoipCidrRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProvisionByoipCidrRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.