/AWS1/CL_EC2IPAMRESOURCECIDR¶
The CIDR for an IPAM resource.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_IPAMID TYPE /AWS1/EC2IPAMID /AWS1/EC2IPAMID¶
The IPAM ID for an IPAM resource.
IV_IPAMSCOPEID TYPE /AWS1/EC2IPAMSCOPEID /AWS1/EC2IPAMSCOPEID¶
The scope ID for an IPAM resource.
IV_IPAMPOOLID TYPE /AWS1/EC2IPAMPOOLID /AWS1/EC2IPAMPOOLID¶
The pool ID for an IPAM resource.
IV_RESOURCEREGION TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The Amazon Web Services Region for an IPAM resource.
IV_RESOURCEOWNERID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The Amazon Web Services account number of the owner of an IPAM resource.
IV_RESOURCEID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of an IPAM resource.
IV_RESOURCENAME TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The name of an IPAM resource.
IV_RESOURCECIDR TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The CIDR for an IPAM resource.
IV_RESOURCETYPE TYPE /AWS1/EC2IPAMRESOURCETYPE /AWS1/EC2IPAMRESOURCETYPE¶
The type of IPAM resource.
IT_RESOURCETAGS TYPE /AWS1/CL_EC2IPAMRESOURCETAG=>TT_IPAMRESOURCETAGLIST TT_IPAMRESOURCETAGLIST¶
The tags for an IPAM resource.
IV_IPUSAGE TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
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).
IV_COMPLIANCESTATUS TYPE /AWS1/EC2IPAMCOMPLIANCESTATUS /AWS1/EC2IPAMCOMPLIANCESTATUS¶
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.
IV_MANAGEMENTSTATE TYPE /AWS1/EC2IPAMMANAGEMENTSTATE /AWS1/EC2IPAMMANAGEMENTSTATE¶
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.
IV_OVERLAPSTATUS TYPE /AWS1/EC2IPAMOVERLAPSTATUS /AWS1/EC2IPAMOVERLAPSTATUS¶
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.
IV_VPCID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The ID of a VPC.
IV_AVAILABILITYZONEID TYPE /AWS1/EC2STRING /AWS1/EC2STRING¶
The Availability Zone ID.
Queryable Attributes¶
IpamId¶
The IPAM ID for an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPAMID() |
Getter for IPAMID, with configurable default |
ASK_IPAMID() |
Getter for IPAMID w/ exceptions if field has no value |
HAS_IPAMID() |
Determine if IPAMID has a value |
IpamScopeId¶
The scope ID for an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPAMSCOPEID() |
Getter for IPAMSCOPEID, with configurable default |
ASK_IPAMSCOPEID() |
Getter for IPAMSCOPEID w/ exceptions if field has no value |
HAS_IPAMSCOPEID() |
Determine if IPAMSCOPEID has a value |
IpamPoolId¶
The pool ID for an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPAMPOOLID() |
Getter for IPAMPOOLID, with configurable default |
ASK_IPAMPOOLID() |
Getter for IPAMPOOLID w/ exceptions if field has no value |
HAS_IPAMPOOLID() |
Determine if IPAMPOOLID has a value |
ResourceRegion¶
The Amazon Web Services Region for an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEREGION() |
Getter for RESOURCEREGION, with configurable default |
ASK_RESOURCEREGION() |
Getter for RESOURCEREGION w/ exceptions if field has no valu |
HAS_RESOURCEREGION() |
Determine if RESOURCEREGION has a value |
ResourceOwnerId¶
The Amazon Web Services account number of the owner of an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEOWNERID() |
Getter for RESOURCEOWNERID, with configurable default |
ASK_RESOURCEOWNERID() |
Getter for RESOURCEOWNERID w/ exceptions if field has no val |
HAS_RESOURCEOWNERID() |
Determine if RESOURCEOWNERID has a value |
ResourceId¶
The ID of an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEID() |
Getter for RESOURCEID, with configurable default |
ASK_RESOURCEID() |
Getter for RESOURCEID w/ exceptions if field has no value |
HAS_RESOURCEID() |
Determine if RESOURCEID has a value |
ResourceName¶
The name of an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCENAME() |
Getter for RESOURCENAME, with configurable default |
ASK_RESOURCENAME() |
Getter for RESOURCENAME w/ exceptions if field has no value |
HAS_RESOURCENAME() |
Determine if RESOURCENAME has a value |
ResourceCidr¶
The CIDR for an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCECIDR() |
Getter for RESOURCECIDR, with configurable default |
ASK_RESOURCECIDR() |
Getter for RESOURCECIDR w/ exceptions if field has no value |
HAS_RESOURCECIDR() |
Determine if RESOURCECIDR has a value |
ResourceType¶
The type of IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCETYPE() |
Getter for RESOURCETYPE, with configurable default |
ASK_RESOURCETYPE() |
Getter for RESOURCETYPE w/ exceptions if field has no value |
HAS_RESOURCETYPE() |
Determine if RESOURCETYPE has a value |
ResourceTags¶
The tags for an IPAM resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCETAGS() |
Getter for RESOURCETAGS, with configurable default |
ASK_RESOURCETAGS() |
Getter for RESOURCETAGS w/ exceptions if field has no value |
HAS_RESOURCETAGS() |
Determine if RESOURCETAGS has a value |
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IPUSAGE() |
Getter for IPUSAGE, with configurable default |
ASK_IPUSAGE() |
Getter for IPUSAGE w/ exceptions if field has no value |
STR_IPUSAGE() |
String format for IPUSAGE, with configurable default |
HAS_IPUSAGE() |
Determine if IPUSAGE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPLIANCESTATUS() |
Getter for COMPLIANCESTATUS, with configurable default |
ASK_COMPLIANCESTATUS() |
Getter for COMPLIANCESTATUS w/ exceptions if field has no va |
HAS_COMPLIANCESTATUS() |
Determine if COMPLIANCESTATUS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MANAGEMENTSTATE() |
Getter for MANAGEMENTSTATE, with configurable default |
ASK_MANAGEMENTSTATE() |
Getter for MANAGEMENTSTATE w/ exceptions if field has no val |
HAS_MANAGEMENTSTATE() |
Determine if MANAGEMENTSTATE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OVERLAPSTATUS() |
Getter for OVERLAPSTATUS, with configurable default |
ASK_OVERLAPSTATUS() |
Getter for OVERLAPSTATUS w/ exceptions if field has no value |
HAS_OVERLAPSTATUS() |
Determine if OVERLAPSTATUS has a value |
VpcId¶
The ID of a VPC.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCID() |
Getter for VPCID, with configurable default |
ASK_VPCID() |
Getter for VPCID w/ exceptions if field has no value |
HAS_VPCID() |
Determine if VPCID has a value |
AvailabilityZoneId¶
The Availability Zone ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABILITYZONEID() |
Getter for AVAILABILITYZONEID, with configurable default |
ASK_AVAILABILITYZONEID() |
Getter for AVAILABILITYZONEID w/ exceptions if field has no |
HAS_AVAILABILITYZONEID() |
Determine if AVAILABILITYZONEID has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_IPAMRESOURCECIDRSET¶
TYPES TT_IPAMRESOURCECIDRSET TYPE STANDARD TABLE OF REF TO /AWS1/CL_EC2IPAMRESOURCECIDR WITH DEFAULT KEY
.