Modify Ipam Resource Discovery

ec2_modify_ipam_resource_discovery

R Documentation

Modifies a resource discovery

Description

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Usage

ec2_modify_ipam_resource_discovery(DryRun, IpamResourceDiscoveryId,
  Description, AddOperatingRegions, RemoveOperatingRegions,
  AddOrganizationalUnitExclusions, RemoveOrganizationalUnitExclusions)

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.

IpamResourceDiscoveryId

[required] A resource discovery ID.

Description

A resource discovery description.

AddOperatingRegions

Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

RemoveOperatingRegions

Remove operating Regions.

AddOrganizationalUnitExclusions

Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

RemoveOrganizationalUnitExclusions

Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Value

A list with the following syntax:

list(
  IpamResourceDiscovery = list(
    OwnerId = "string",
    IpamResourceDiscoveryId = "string",
    IpamResourceDiscoveryArn = "string",
    IpamResourceDiscoveryRegion = "string",
    Description = "string",
    OperatingRegions = list(
      list(
        RegionName = "string"
      )
    ),
    IsDefault = TRUE|FALSE,
    State = "create-in-progress"|"create-complete"|"create-failed"|"modify-in-progress"|"modify-complete"|"modify-failed"|"delete-in-progress"|"delete-complete"|"delete-failed"|"isolate-in-progress"|"isolate-complete"|"restore-in-progress",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    OrganizationalUnitExclusions = list(
      list(
        OrganizationsEntityPath = "string"
      )
    )
  )
)

Request syntax

svc$modify_ipam_resource_discovery(
  DryRun = TRUE|FALSE,
  IpamResourceDiscoveryId = "string",
  Description = "string",
  AddOperatingRegions = list(
    list(
      RegionName = "string"
    )
  ),
  RemoveOperatingRegions = list(
    list(
      RegionName = "string"
    )
  ),
  AddOrganizationalUnitExclusions = list(
    list(
      OrganizationsEntityPath = "string"
    )
  ),
  RemoveOrganizationalUnitExclusions = list(
    list(
      OrganizationsEntityPath = "string"
    )
  )
)