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

Class Vpc

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

Describes a VPC.

See Also:

  • Method Details

    • cidrBlock

      public final String cidrBlock()

      The primary IPv4 CIDR block for the VPC.

      Returns:
      The primary IPv4 CIDR block for the VPC.

    • dhcpOptionsId

      public final String dhcpOptionsId()

      The ID of the set of DHCP options you've associated with the VPC.

      Returns:
      The ID of the set of DHCP options you've associated with the VPC.

    • state

      public final VpcState state()

      The current state of the VPC.

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

      Returns:
      The current state of the VPC.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the VPC.

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

      Returns:
      The current state of the VPC.
      See Also:

    • vpcId

      public final String vpcId()

      The ID of the VPC.

      Returns:
      The ID of the VPC.

    • ownerId

      public final String ownerId()

      The ID of the Amazon Web Services account that owns the VPC.

      Returns:
      The ID of the Amazon Web Services account that owns the VPC.

    • instanceTenancy

      public final Tenancy instanceTenancy()

      The allowed tenancy of instances launched into the VPC.

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

      Returns:
      The allowed tenancy of instances launched into the VPC.
      See Also:

    • instanceTenancyAsString

      public final String instanceTenancyAsString()

      The allowed tenancy of instances launched into the VPC.

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

      Returns:
      The allowed tenancy of instances launched into the VPC.
      See Also:

    • hasIpv6CidrBlockAssociationSet

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

    • ipv6CidrBlockAssociationSet

      public final List<VpcIpv6CidrBlockAssociation> ipv6CidrBlockAssociationSet()

      Information about the IPv6 CIDR blocks associated with the VPC.

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

      Returns:
      Information about the IPv6 CIDR blocks associated with the VPC.

    • hasCidrBlockAssociationSet

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

    • cidrBlockAssociationSet

      public final List<VpcCidrBlockAssociation> cidrBlockAssociationSet()

      Information about the IPv4 CIDR blocks associated with the VPC.

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

      Returns:
      Information about the IPv4 CIDR blocks associated with the VPC.

    • isDefault

      public final Boolean isDefault()

      Indicates whether the VPC is the default VPC.

      Returns:
      Indicates whether the VPC is the default VPC.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Any tags assigned to the VPC.

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

      Returns:
      Any tags assigned to the VPC.

    • toBuilder

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

    • builder

      public static Vpc.Builder builder()

    • serializableBuilderClass

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