EC2 / Client / modify_ipam_resource_cidr

modify_ipam_resource_cidr

EC2.Client.modify_ipam_resource_cidr(**kwargs)

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_ipam_resource_cidr(
    DryRun=True|False,
    ResourceId='string',
    ResourceCidr='string',
    ResourceRegion='string',
    CurrentIpamScopeId='string',
    DestinationIpamScopeId='string',
    Monitored=True|False
)

Parameters:

• DryRun (boolean) – A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

• ResourceId (string) –

  [REQUIRED]

  The ID of the resource you want to modify.

• ResourceCidr (string) –

  [REQUIRED]

  The CIDR of the resource you want to modify.

• ResourceRegion (string) –

  [REQUIRED]

  The Amazon Web Services Region of the resource you want to modify.

• CurrentIpamScopeId (string) –

  [REQUIRED]

  The ID of the current scope that the resource CIDR is in.

• DestinationIpamScopeId (string) – The ID of the scope you want to transfer the resource CIDR to.

• Monitored (boolean) –

  [REQUIRED]

  Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.

Return type:

dict

Returns:

Response Syntax

{
    'IpamResourceCidr': {
        'IpamId': 'string',
        'IpamScopeId': 'string',
        'IpamPoolId': 'string',
        'ResourceRegion': 'string',
        'ResourceOwnerId': 'string',
        'ResourceId': 'string',
        'ResourceName': 'string',
        'ResourceCidr': 'string',
        'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni',
        'ResourceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'IpUsage': 123.0,
        'ComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored',
        'ManagementState': 'managed'|'unmanaged'|'ignored',
        'OverlapStatus': 'overlapping'|'nonoverlapping'|'ignored',
        'VpcId': 'string'
    }
}

Response Structure

• (dict) –

  • IpamResourceCidr (dict) –

    The CIDR of the resource.

    • IpamId (string) –

      The IPAM ID for an IPAM resource.

    • IpamScopeId (string) –

      The scope ID for an IPAM resource.

    • IpamPoolId (string) –

      The pool ID for an IPAM resource.

    • ResourceRegion (string) –

      The Amazon Web Services Region for an IPAM resource.

    • ResourceOwnerId (string) –

      The Amazon Web Services account number of the owner of an IPAM resource.

    • ResourceId (string) –

      The ID of an IPAM resource.

    • ResourceName (string) –

      The name of an IPAM resource.

    • ResourceCidr (string) –

      The CIDR for an IPAM resource.

    • ResourceType (string) –

      The type of IPAM resource.

    • ResourceTags (list) –

      The tags for an IPAM resource.

      • (dict) –

        The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

        • Key (string) –

          The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

        • Value (string) –

          The value of the tag.

    • IpUsage (float) –

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

      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.

    • ManagementState (string) –

      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.

    • OverlapStatus (string) –

      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.

    • VpcId (string) –

      The ID of a VPC.