AWS::EC2::IPAMPrefixListResolver - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EC2::IPAMPrefixListResolver

Describes an IPAM prefix list resolver.

An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::IPAMPrefixListResolver",
  "Properties" : {
      "AddressFamily" : String,
      "Description" : String,
      "IpamId" : String,
      "Rules" : [ IpamPrefixListResolverRule, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::IPAMPrefixListResolver
Properties:
  AddressFamily: String
  Description: String
  IpamId: String
  Rules: 
    - IpamPrefixListResolverRule
  Tags: 
    - Tag

Properties

AddressFamily

The address family (IPv4 or IPv6) for the IPAM prefix list resolver.

Required: Yes

Type: String

Allowed values: ipv4 | ipv6

Update requires: Replacement

Description

The description of the IPAM prefix list resolver.

Required: No

Type: String

Update requires: No interruption

IpamId

The ID of the IPAM associated with this resolver.

Required: No

Type: String

Update requires: Replacement

Rules

CIDR selection rules for this resolver.

Required: No

Type: Array of IpamPrefixListResolverRule

Update requires: No interruption

Tags

The tags assigned to the IPAM prefix list resolver.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the prefix list resolver ID. For example: ipam-plr-111122223333.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

IpamArn

The Amazon Resource Name (ARN) of the IPAM associated with this resolver.

IpamPrefixListResolverArn

The Amazon Resource Name (ARN) of the IPAM prefix list resolver.

IpamPrefixListResolverId

The ID of the IPAM prefix list resolver.