Class IpamDiscoveredResourceCidr
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.IpamDiscoveredResourceCidr
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,IpamDiscoveredResourceCidr>
@Generated("software.amazon.awssdk:codegen") public final class IpamDiscoveredResourceCidr extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,IpamDiscoveredResourceCidr>
An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IpamDiscoveredResourceCidr.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IpamDiscoveredResourceCidr.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasResourceTags()
For responses, this returns true if the service returned a value for the ResourceTags property.String
ipamResourceDiscoveryId()
The resource discovery ID.Double
ipUsage()
The percentage of IP address space in use.String
resourceCidr()
The resource CIDR.String
resourceId()
The resource ID.String
resourceOwnerId()
The resource owner ID.String
resourceRegion()
The resource Region.List<IpamResourceTag>
resourceTags()
The resource tags.IpamResourceType
resourceType()
The resource type.String
resourceTypeAsString()
The resource type.Instant
sampleTime()
The last successful resource discovery time.List<SdkField<?>>
sdkFields()
static Class<? extends IpamDiscoveredResourceCidr.Builder>
serializableBuilderClass()
IpamDiscoveredResourceCidr.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
vpcId()
The VPC ID.-
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
-
ipamResourceDiscoveryId
public final String ipamResourceDiscoveryId()
The resource discovery ID.
- Returns:
- The resource discovery ID.
-
resourceRegion
public final String resourceRegion()
The resource Region.
- Returns:
- The resource Region.
-
resourceId
public final String resourceId()
The resource ID.
- Returns:
- The resource ID.
-
resourceOwnerId
public final String resourceOwnerId()
The resource owner ID.
- Returns:
- The resource owner ID.
-
resourceCidr
public final String resourceCidr()
The resource CIDR.
- Returns:
- The resource CIDR.
-
resourceType
public final IpamResourceType resourceType()
The resource type.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnIpamResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type.
- See Also:
IpamResourceType
-
resourceTypeAsString
public final String resourceTypeAsString()
The resource type.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnIpamResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type.
- See Also:
IpamResourceType
-
hasResourceTags
public final boolean hasResourceTags()
For responses, this returns true if the service returned a value for the ResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
resourceTags
public final List<IpamResourceTag> resourceTags()
The resource tags.
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
hasResourceTags()
method.- Returns:
- The resource tags.
-
ipUsage
public final Double ipUsage()
The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:
-
For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
-
For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
-
For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).
- Returns:
- The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal
by 100. Note the following:
-
For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs.
-
For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
-
For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).
-
-
-
vpcId
public final String vpcId()
The VPC ID.
- Returns:
- The VPC ID.
-
sampleTime
public final Instant sampleTime()
The last successful resource discovery time.
- Returns:
- The last successful resource discovery time.
-
toBuilder
public IpamDiscoveredResourceCidr.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,IpamDiscoveredResourceCidr>
-
builder
public static IpamDiscoveredResourceCidr.Builder builder()
-
serializableBuilderClass
public static Class<? extends IpamDiscoveredResourceCidr.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-