Get Ipam Policy Allocation Rules

ec2_get_ipam_policy_allocation_rules

R Documentation

Gets the allocation rules for an IPAM policy

Description

Gets the allocation rules for an 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.

Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

Usage

ec2_get_ipam_policy_allocation_rules(DryRun, IpamPolicyId, Filters,
  Locale, ResourceType, MaxResults, NextToken)

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.
IpamPolicyId	[required] The ID of the IPAM policy for which to get allocation rules.
Filters	One or more filters for the allocation rules.
Locale	The locale for which to get the allocation rules.
ResourceType	The resource type for which to get the allocation rules. The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include: Elastic IP addresses
MaxResults	The maximum number of results to return in a single call.
NextToken	The token for the next page of results.

Value

A list with the following syntax:

list(
  IpamPolicyDocuments = list(
    list(
      IpamPolicyId = "string",
      Locale = "string",
      ResourceType = "alb"|"eip"|"rds"|"rnat",
      AllocationRules = list(
        list(
          SourceIpamPoolId = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_ipam_policy_allocation_rules(
  DryRun = TRUE|FALSE,
  IpamPolicyId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Locale = "string",
  ResourceType = "alb"|"eip"|"rds"|"rnat",
  MaxResults = 123,
  NextToken = "string"
)