Class IpamDiscoveredResourceCidr
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResourceTags property.final String
The resource discovery ID.final Double
ipUsage()
The percentage of IP address space in use.final String
The resource CIDR.final String
The resource ID.final String
The resource owner ID.final String
The resource Region.final List
<IpamResourceTag> The resource tags.final IpamResourceType
The resource type.final String
The resource type.final Instant
The last successful resource discovery time.static Class
<? extends IpamDiscoveredResourceCidr.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
vpcId()
The VPC ID.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ipamResourceDiscoveryId
The resource discovery ID.
- Returns:
- The resource discovery ID.
-
resourceRegion
The resource Region.
- Returns:
- The resource Region.
-
resourceId
The resource ID.
- Returns:
- The resource ID.
-
resourceOwnerId
The resource owner ID.
- Returns:
- The resource owner ID.
-
resourceCidr
The resource CIDR.
- Returns:
- The resource CIDR.
-
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:
-
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:
-
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
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
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
The VPC ID.
- Returns:
- The VPC ID.
-
sampleTime
The last successful resource discovery time.
- Returns:
- The last successful resource discovery time.
-
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 interfaceToCopyableBuilder<IpamDiscoveredResourceCidr.Builder,
IpamDiscoveredResourceCidr> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-