Get Ipam Resource Cidrs

ec2_get_ipam_resource_cidrs

R Documentation

Returns resource CIDRs managed by IPAM in a given scope

Description

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Usage

ec2_get_ipam_resource_cidrs(DryRun, Filters, MaxResults, NextToken,
  IpamScopeId, IpamPoolId, ResourceId, ResourceType, ResourceTag,
  ResourceOwner)

Arguments

DryRun

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.

Filters

One or more filters for the request. For more information about filtering, see Filtering CLI output.

MaxResults

The maximum number of results to return in the request.

NextToken

The token for the next page of results.

IpamScopeId

[required] The ID of the scope that the resource is in.

IpamPoolId

The ID of the IPAM pool that the resource is in.

ResourceId

The ID of the resource.

ResourceType

The resource type.

ResourceTag

The resource tag.

ResourceOwner

The ID of the Amazon Web Services account that owns the resource.

Value

A list with the following syntax:

list(
  NextToken = "string",
  IpamResourceCidrs = list(
    list(
      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 = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      IpUsage = 123.0,
      ComplianceStatus = "compliant"|"noncompliant"|"unmanaged"|"ignored",
      ManagementState = "managed"|"unmanaged"|"ignored",
      OverlapStatus = "overlapping"|"nonoverlapping"|"ignored",
      VpcId = "string",
      AvailabilityZoneId = "string"
    )
  )
)

Request syntax

svc$get_ipam_resource_cidrs(
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  IpamScopeId = "string",
  IpamPoolId = "string",
  ResourceId = "string",
  ResourceType = "vpc"|"subnet"|"eip"|"public-ipv4-pool"|"ipv6-pool"|"eni",
  ResourceTag = list(
    Key = "string",
    Value = "string"
  ),
  ResourceOwner = "string"
)