Class ProvisionIpamPoolCidrRequest

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.ProvisionIpamPoolCidrRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ProvisionIpamPoolCidrRequest.Builder,ProvisionIpamPoolCidrRequest>
@Generated("software.amazon.awssdk:codegen") public final class ProvisionIpamPoolCidrRequest extends Ec2Request implements ToCopyableBuilder<ProvisionIpamPoolCidrRequest.Builder,ProvisionIpamPoolCidrRequest>

  • Method Details

    • dryRun

      public final Boolean dryRun()

      A check for 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:
      A check for 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.

    • ipamPoolId

      public final String ipamPoolId()

      The ID of the IPAM pool to which you want to assign a CIDR.

      Returns:
      The ID of the IPAM pool to which you want to assign a CIDR.

    • cidr

      public final String cidr()

      The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.

      Returns:
      The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.

    • cidrAuthorizationContext

      public final IpamCidrAuthorizationContext cidrAuthorizationContext()

      A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

      Returns:
      A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope.

    • netmaskLength

      public final Integer netmaskLength()

      The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.

      Returns:
      The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

    • verificationMethod

      public final VerificationMethod verificationMethod()

      The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

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

      Returns:
      The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
      See Also:

    • verificationMethodAsString

      public final String verificationMethodAsString()

      The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.

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

      Returns:
      The method for verifying control of a public IP address range. Defaults to remarks-x509 if not specified. This option only applies to IPv4 and IPv6 pools in the public scope.
      See Also:

    • ipamExternalResourceVerificationTokenId

      public final String ipamExternalResourceVerificationTokenId()

      Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

      Returns:
      Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope.

    • toBuilder

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

    • builder

      public static ProvisionIpamPoolCidrRequest.Builder builder()

    • serializableBuilderClass

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