Package software.amazon.awscdk.services.ec2

Interface CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty.Jsii$Proxy

Enclosing class:

CfnIPAMPrefixListResolver

@Stability(Stable)
public static interface CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 IpamPrefixListResolverRuleProperty ipamPrefixListResolverRuleProperty = IpamPrefixListResolverRuleProperty.builder()
         .ruleType("ruleType")
         // the properties below are optional
         .conditions(List.of(IpamPrefixListResolverRuleConditionProperty.builder()
                 .operation("operation")
                 // the properties below are optional
                 .cidr("cidr")
                 .ipamPoolId("ipamPoolId")
                 .resourceId("resourceId")
                 .resourceOwner("resourceOwner")
                 .resourceRegion("resourceRegion")
                 .resourceTag(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build())
                 .build()))
         .ipamScopeId("ipamScopeId")
         .resourceType("resourceType")
         .staticCidr("staticCidr")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty.Builder	A builder for CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty
static final class	CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty.Jsii$Proxy	An implementation for CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty.Builder	builder()
default Object	getConditions()	Two of the rule types allow you to add conditions to the rules.
default String	getIpamScopeId()	This rule will only match resources that are in this IPAM Scope.
default String	getResourceType()	The resourceType property only applies to ipam-resource-cidr rules;
String	getRuleType()	There are three rule types: (1) Static CIDR: A fixed list of CIDRs that don't change (like a manual list replicated across Regions).
default String	getStaticCidr()	A fixed CIDR that doesn't change.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuleType

@Stability(Stable)
@NotNull
String getRuleType()

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

getConditions

@Stability(Stable)
@Nullable
default Object getConditions()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleConditionProperty>

See Also:

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

getIpamScopeId

@Stability(Stable)
@Nullable
default String getIpamScopeId()

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

getResourceType

@Stability(Stable)
@Nullable
default String getResourceType()

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

getStaticCidr

@Stability(Stable)
@Nullable
default String getStaticCidr()

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

builder

@Stability(Stable)
static CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty.Builder builder()

Returns:

a CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty.Builder of CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty