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(value="software.amazon.awssdk:codegen")
public final class Vpc
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Vpc.Builder,Vpc>

Describes a VPC.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Vpc.Builder

Method Summary

Modifier and Type	Method and Description
static Vpc.Builder	builder()
String	cidrBlock() The primary IPv4 CIDR block for the VPC.
List<VpcCidrBlockAssociation>	cidrBlockAssociationSet() Information about the IPv4 CIDR blocks associated with the VPC.
String	dhcpOptionsId() The ID of the set of DHCP options you've associated with the VPC.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCidrBlockAssociationSet() For responses, this returns true if the service returned a value for the CidrBlockAssociationSet property.
int	hashCode()
boolean	hasIpv6CidrBlockAssociationSet() For responses, this returns true if the service returned a value for the Ipv6CidrBlockAssociationSet property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Tenancy	instanceTenancy() The allowed tenancy of instances launched into the VPC.
String	instanceTenancyAsString() The allowed tenancy of instances launched into the VPC.
List<VpcIpv6CidrBlockAssociation>	ipv6CidrBlockAssociationSet() Information about the IPv6 CIDR blocks associated with the VPC.
Boolean	isDefault() Indicates whether the VPC is the default VPC.
String	ownerId() The ID of the Amazon Web Services account that owns the VPC.
List<SdkField<?>>	sdkFields()
static Class<? extends Vpc.Builder>	serializableBuilderClass()
VpcState	state() The current state of the VPC.
String	stateAsString() The current state of the VPC.
List<Tag>	tags() Any tags assigned to the VPC.
Vpc.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcId() The ID of the VPC.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

VpcState

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:

VpcState

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:

Tenancy

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:

Tenancy

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Vpc.Builder,Vpc>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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