Skip to content

Get Enabled Ipam Policy

ec2_get_enabled_ipam_policy R Documentation

Gets the enabled IPAM policy

Description

Gets the enabled IPAM policy.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

Usage

ec2_get_enabled_ipam_policy(DryRun)

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.

Value

A list with the following syntax:

list(
  IpamPolicyEnabled = TRUE|FALSE,
  IpamPolicyId = "string",
  ManagedBy = "account"|"delegated-administrator-for-ipam"
)

Request syntax

svc$get_enabled_ipam_policy(
  DryRun = TRUE|FALSE
)