Class IpamResourceCidr
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.IpamResourceCidr
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IpamResourceCidr.Builder,IpamResourceCidr>
@Generated("software.amazon.awssdk:codegen") public final class IpamResourceCidr extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamResourceCidr.Builder,IpamResourceCidr>
The CIDR for an IPAM resource.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IpamResourceCidr.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IpamResourceCidr.Builder
builder()
IpamComplianceStatus
complianceStatus()
The compliance status of the IPAM resource.String
complianceStatusAsString()
The compliance status of the IPAM resource.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
ipamId()
The IPAM ID for an IPAM resource.String
ipamPoolId()
The pool ID for an IPAM resource.String
ipamScopeId()
The scope ID for an IPAM resource.Double
ipUsage()
The percentage of IP address space in use.IpamManagementState
managementState()
The management state of the resource.String
managementStateAsString()
The management state of the resource.IpamOverlapStatus
overlapStatus()
The overlap status of an IPAM resource.String
overlapStatusAsString()
The overlap status of an IPAM resource.String
resourceCidr()
The CIDR for an IPAM resource.String
resourceId()
The ID of an IPAM resource.String
resourceName()
The name of an IPAM resource.String
resourceOwnerId()
The Amazon Web Services account number of the owner of an IPAM resource.String
resourceRegion()
The Amazon Web Services Region for an IPAM resource.List<IpamResourceTag>
resourceTags()
The tags for an IPAM resource.IpamResourceType
resourceType()
The type of IPAM resource.String
resourceTypeAsString()
The type of IPAM resource.List<SdkField<?>>
sdkFields()
static Class<? extends IpamResourceCidr.Builder>
serializableBuilderClass()
IpamResourceCidr.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
vpcId()
The ID of a 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
-
ipamId
public final String ipamId()
The IPAM ID for an IPAM resource.
- Returns:
- The IPAM ID for an IPAM resource.
-
ipamScopeId
public final String ipamScopeId()
The scope ID for an IPAM resource.
- Returns:
- The scope ID for an IPAM resource.
-
ipamPoolId
public final String ipamPoolId()
The pool ID for an IPAM resource.
- Returns:
- The pool ID for an IPAM resource.
-
resourceRegion
public final String resourceRegion()
The Amazon Web Services Region for an IPAM resource.
- Returns:
- The Amazon Web Services Region for an IPAM resource.
-
resourceOwnerId
public final String resourceOwnerId()
The Amazon Web Services account number of the owner of an IPAM resource.
- Returns:
- The Amazon Web Services account number of the owner of an IPAM resource.
-
resourceId
public final String resourceId()
The ID of an IPAM resource.
- Returns:
- The ID of an IPAM resource.
-
resourceName
public final String resourceName()
The name of an IPAM resource.
- Returns:
- The name of an IPAM resource.
-
resourceCidr
public final String resourceCidr()
The CIDR for an IPAM resource.
- Returns:
- The CIDR for an IPAM resource.
-
resourceType
public final IpamResourceType resourceType()
The type of IPAM resource.
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 type of IPAM resource.
- See Also:
IpamResourceType
-
resourceTypeAsString
public final String resourceTypeAsString()
The type of IPAM resource.
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 type of IPAM resource.
- 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 tags for an IPAM resource.
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 tags for an IPAM resource.
-
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).
-
-
-
complianceStatus
public final IpamComplianceStatus complianceStatus()
The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
If the service returns an enum value that is not available in the current SDK version,
complianceStatus
will returnIpamComplianceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomplianceStatusAsString()
.- Returns:
- The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
- See Also:
IpamComplianceStatus
-
complianceStatusAsString
public final String complianceStatusAsString()
The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
If the service returns an enum value that is not available in the current SDK version,
complianceStatus
will returnIpamComplianceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomplianceStatusAsString()
.- Returns:
- The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
- See Also:
IpamComplianceStatus
-
managementState
public final IpamManagementState managementState()
The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
If the service returns an enum value that is not available in the current SDK version,
managementState
will returnIpamManagementState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagementStateAsString()
.- Returns:
- The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
- See Also:
IpamManagementState
-
managementStateAsString
public final String managementStateAsString()
The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
If the service returns an enum value that is not available in the current SDK version,
managementState
will returnIpamManagementState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommanagementStateAsString()
.- Returns:
- The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
- See Also:
IpamManagementState
-
overlapStatus
public final IpamOverlapStatus overlapStatus()
The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
If the service returns an enum value that is not available in the current SDK version,
overlapStatus
will returnIpamOverlapStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverlapStatusAsString()
.- Returns:
- The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
- See Also:
IpamOverlapStatus
-
overlapStatusAsString
public final String overlapStatusAsString()
The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
If the service returns an enum value that is not available in the current SDK version,
overlapStatus
will returnIpamOverlapStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverlapStatusAsString()
.- Returns:
- The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
- See Also:
IpamOverlapStatus
-
vpcId
public final String vpcId()
The ID of a VPC.
- Returns:
- The ID of a VPC.
-
toBuilder
public IpamResourceCidr.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<IpamResourceCidr.Builder,IpamResourceCidr>
-
builder
public static IpamResourceCidr.Builder builder()
-
serializableBuilderClass
public static Class<? extends IpamResourceCidr.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.
-
-