Package software.amazon.awscdk.services.ec2

Class CfnIPAMPrefixListResolver

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnIPAMPrefixListResolver
All Implemented Interfaces:
IInspectable, IIPAMPrefixListResolverRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:42.501Z") @Stability(Stable) public class CfnIPAMPrefixListResolver extends CfnResource implements IInspectable, IIPAMPrefixListResolverRef, ITaggableV2
Resource Type definition for AWS::EC2::IPAMPrefixListResolver.

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.*;
 CfnIPAMPrefixListResolver cfnIPAMPrefixListResolver = CfnIPAMPrefixListResolver.Builder.create(this, "MyCfnIPAMPrefixListResolver")
         .addressFamily("addressFamily")
         // the properties below are optional
         .description("description")
         .ipamId("ipamId")
         .rules(List.of(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()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIPAMPrefixListResolver

      protected CfnIPAMPrefixListResolver(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIPAMPrefixListResolver

      protected CfnIPAMPrefixListResolver(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIPAMPrefixListResolver

      @Stability(Stable) public CfnIPAMPrefixListResolver(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPAMPrefixListResolverProps props)
      Create a new AWS::EC2::IPAMPrefixListResolver.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForIPAMPrefixListResolver

      @Stability(Stable) @NotNull public static String arnForIPAMPrefixListResolver(@NotNull IIPAMPrefixListResolverRef resource)
      Parameters:
      resource - This parameter is required.

    • fromIPAMPrefixListResolverArn

      @Stability(Stable) @NotNull public static IIPAMPrefixListResolverRef fromIPAMPrefixListResolverArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IIPAMPrefixListResolverRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromIpamPrefixListResolverId

      @Stability(Stable) @NotNull public static IIPAMPrefixListResolverRef fromIpamPrefixListResolverId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String ipamPrefixListResolverId)
      Creates a new IIPAMPrefixListResolverRef from a ipamPrefixListResolverId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      ipamPrefixListResolverId - This parameter is required.

    • isCfnIPAMPrefixListResolver

      @Stability(Stable) @NotNull public static Boolean isCfnIPAMPrefixListResolver(@NotNull Object x)
      Checks whether the given object is a CfnIPAMPrefixListResolver.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrIpamArn

      @Stability(Stable) @NotNull public String getAttrIpamArn()
      The Amazon Resource Name (ARN) of the IPAM this Prefix List Resolver is a part of.

    • getAttrIpamPrefixListResolverArn

      @Stability(Stable) @NotNull public String getAttrIpamPrefixListResolverArn()
      The Amazon Resource Name (ARN) of the IPAM Prefix List Resolver.

    • getAttrIpamPrefixListResolverId

      @Stability(Stable) @NotNull public String getAttrIpamPrefixListResolverId()
      Id of the IPAM Prefix List Resolver.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIpamPrefixListResolverRef

      @Stability(Stable) @NotNull public IPAMPrefixListResolverReference getIpamPrefixListResolverRef()
      A reference to a IPAMPrefixListResolver resource.
      Specified by:
      getIpamPrefixListResolverRef in interface IIPAMPrefixListResolverRef

    • getAddressFamily

      @Stability(Stable) @NotNull public String getAddressFamily()
      The address family of the address space in this Prefix List Resolver.

    • setAddressFamily

      @Stability(Stable) public void setAddressFamily(@NotNull String value)
      The address family of the address space in this Prefix List Resolver.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)

    • getIpamId

      @Stability(Stable) @Nullable public String getIpamId()
      The Id of the IPAM this Prefix List Resolver is a part of.

    • setIpamId

      @Stability(Stable) public void setIpamId(@Nullable String value)
      The Id of the IPAM this Prefix List Resolver is a part of.

    • getRules

      @Stability(Stable) @Nullable public Object getRules()
      Rules define the business logic for selecting CIDRs from IPAM.

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

    • setRules

      @Stability(Stable) public void setRules(@Nullable IResolvable value)
      Rules define the business logic for selecting CIDRs from IPAM.

    • setRules

      @Stability(Stable) public void setRules(@Nullable List<Object> value)
      Rules define the business logic for selecting CIDRs from IPAM.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.