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

Class CreateSubnetRequest

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

  • Method Details

    • hasTagSpecifications

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

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to assign to the subnet.

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

      Returns:
      The tags to assign to the subnet.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone or Local Zone for the subnet.

      Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

      To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Local Zones locations.

      To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

      Returns:
      The Availability Zone or Local Zone for the subnet.

      Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

      To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Local Zones locations.

      To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

    • availabilityZoneId

      public final String availabilityZoneId()

      The AZ ID or the Local Zone ID of the subnet.

      Returns:
      The AZ ID or the Local Zone ID of the subnet.

    • cidrBlock

      public final String cidrBlock()

      The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

      This parameter is not supported for an IPv6 only subnet.

      Returns:
      The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

      This parameter is not supported for an IPv6 only subnet.

    • ipv6CidrBlock

      public final String ipv6CidrBlock()

      The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.

      Returns:
      The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet.

    • outpostArn

      public final String outpostArn()

      The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.

      Returns:
      The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.

    • vpcId

      public final String vpcId()

      The ID of the VPC.

      Returns:
      The ID of the VPC.

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

    • ipv6Native

      public final Boolean ipv6Native()

      Indicates whether to create an IPv6 only subnet.

      Returns:
      Indicates whether to create an IPv6 only subnet.

    • ipv4IpamPoolId

      public final String ipv4IpamPoolId()

      An IPv4 IPAM pool ID for the subnet.

      Returns:
      An IPv4 IPAM pool ID for the subnet.

    • ipv4NetmaskLength

      public final Integer ipv4NetmaskLength()

      An IPv4 netmask length for the subnet.

      Returns:
      An IPv4 netmask length for the subnet.

    • ipv6IpamPoolId

      public final String ipv6IpamPoolId()

      An IPv6 IPAM pool ID for the subnet.

      Returns:
      An IPv6 IPAM pool ID for the subnet.

    • ipv6NetmaskLength

      public final Integer ipv6NetmaskLength()

      An IPv6 netmask length for the subnet.

      Returns:
      An IPv6 netmask length for the subnet.

    • toBuilder

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

    • builder

      public static CreateSubnetRequest.Builder builder()

    • serializableBuilderClass

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