2.243.0

interface IpamPrefixListResolverRuleProperty

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnIPAMPrefixListResolver_IpamPrefixListResolverRuleProperty
Javasoftware.amazon.awscdk.services.ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty
Pythonaws_cdk.aws_ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty
TypeScript aws-cdk-lib » aws_ec2 » CfnIPAMPrefixListResolver » IpamPrefixListResolverRuleProperty

CIDR selection rules define the business logic for selecting CIDRs from IPAM.

If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without rules, but you'll need to add at least one rule before it can actually automate your prefix list updates.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const ipamPrefixListResolverRuleProperty: ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty = {
  ruleType: 'ruleType',

  // the properties below are optional
  conditions: [{
    operation: 'operation',

    // the properties below are optional
    cidr: 'cidr',
    ipamPoolId: 'ipamPoolId',
    resourceId: 'resourceId',
    resourceOwner: 'resourceOwner',
    resourceRegion: 'resourceRegion',
    resourceTag: {
      key: 'key',
      value: 'value',
    },
  }],
  ipamScopeId: 'ipamScopeId',
  resourceType: 'resourceType',
  staticCidr: 'staticCidr',
};

Properties

NameTypeDescription
ruleTypestringThere are three rule types: (1) Static CIDR: A fixed list of CIDRs that don't change (like a manual list replicated across Regions).
conditions?IResolvable | (IResolvable | IpamPrefixListResolverRuleConditionProperty)[]Two of the rule types allow you to add conditions to the rules.
ipamScopeId?stringThis rule will only match resources that are in this IPAM Scope.
resourceType?stringThe resourceType property only applies to ipam-resource-cidr rules;
staticCidr?stringA fixed CIDR that doesn't change.

ruleType

Type: string

There are three rule types: (1) Static CIDR: A fixed list of CIDRs that don't change (like a manual list replicated across Regions).

(2) IPAM pool CIDR: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool). (3) IPAM resource CIDR: CIDRs for AWS resources like VPCs, subnets, and EIPs within a specific IPAM scope.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-ruletype

conditions?

Type: IResolvable | (IResolvable | IpamPrefixListResolverRuleConditionProperty)[] (optional)

Two of the rule types allow you to add conditions to the rules.

(1) For IPAM Pool CIDR rules, you can specify an ipamPoolId; if not specified, the rule will apply to all IPAM Pool CIDRs in the scope. (2) For IPAM Resource CIDR rules, you can specify resourceId, resourceOwner, resourceRegion, cidr, or resourceTag.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-conditions

ipamScopeId?

Type: string (optional)

This rule will only match resources that are in this IPAM Scope.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-ipamscopeid

resourceType?

Type: string (optional)

The resourceType property only applies to ipam-resource-cidr rules;

this property specifies what type of resources this rule will apply to, such as VPCs or Subnets.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-resourcetype

staticCidr?

Type: string (optional)

A fixed CIDR that doesn't change.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-staticcidr

← PreviousNext →