Modify Ipam Policy Allocation Rules

ec2_modify_ipam_policy_allocation_rules

R Documentation

Modifies the allocation rules in an IPAM policy

Description

Modifies the allocation rules in 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_modify_ipam_policy_allocation_rules(DryRun, IpamPolicyId, Locale,
  ResourceType, AllocationRules)

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 whose allocation rules you want to modify.
Locale	[required] The locale for which to modify the allocation rules.
ResourceType	[required] The resource type for which to modify 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
AllocationRules	The new allocation rules to apply to the IPAM policy. 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.

Value

A list with the following syntax:

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

Request syntax

svc$modify_ipam_policy_allocation_rules(
  DryRun = TRUE|FALSE,
  IpamPolicyId = "string",
  Locale = "string",
  ResourceType = "alb"|"eip"|"rds"|"rnat",
  AllocationRules = list(
    list(
      SourceIpamPoolId = "string"
    )
  )
)