Class CfnIPAMPool
A CloudFormation AWS::EC2::IPAMPool
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnIPAMPool : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnIPAMPool
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
CloudformationResource: AWS::EC2::IPAMPool
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnIPAMPool = new CfnIPAMPool(this, "MyCfnIPAMPool", new CfnIPAMPoolProps {
AddressFamily = "addressFamily",
IpamScopeId = "ipamScopeId",
// the properties below are optional
AllocationDefaultNetmaskLength = 123,
AllocationMaxNetmaskLength = 123,
AllocationMinNetmaskLength = 123,
AllocationResourceTags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
AutoImport = false,
AwsService = "awsService",
Description = "description",
Locale = "locale",
ProvisionedCidrs = new [] { new ProvisionedCidrProperty {
Cidr = "cidr"
} },
PublicIpSource = "publicIpSource",
PubliclyAdvertisable = false,
SourceIpamPoolId = "sourceIpamPoolId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnIPAMPool(Construct, String, ICfnIPAMPoolProps) | Create a new |
CfnIPAMPool(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIPAMPool(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AddressFamily | The address family of the pool. |
AllocationDefaultNetmaskLength | The default netmask length for allocations added to this pool. |
AllocationMaxNetmaskLength | The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. |
AllocationMinNetmaskLength | The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. |
AllocationResourceTags | Tags that are required for resources that use CIDRs from this IPAM pool. |
AttrArn | The ARN of the IPAM pool. |
AttrIpamArn | The ARN of the IPAM. |
AttrIpamPoolId | The ID of the IPAM pool. |
AttrIpamScopeArn | The ARN of the scope of the IPAM pool. |
AttrIpamScopeType | The scope of the IPAM. |
AttrPoolDepth | The depth of pools in your IPAM pool. |
AttrState | The state of the IPAM pool. |
AttrStateMessage | A message related to the failed creation of an IPAM pool. |
AutoImport | If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. |
AwsService | Limits which service in AWS that the pool can be used in. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the IPAM pool. |
IpamScopeId | The ID of the scope in which you would like to create the IPAM pool. |
Locale | The locale of the IPAM pool. |
ProvisionedCidrs | Information about the CIDRs provisioned to an IPAM pool. |
PublicIpSource | The IP address source for pools in the public scope. |
PubliclyAdvertisable | Determines if a pool is publicly advertisable. |
SourceIpamPoolId | The ID of the source IPAM pool. |
Tags | The key/value combination of a tag assigned to the resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIPAMPool(Construct, String, ICfnIPAMPoolProps)
Create a new AWS::EC2::IPAMPool
.
public CfnIPAMPool(Construct scope, string id, ICfnIPAMPoolProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnIPAMPoolProps
- resource properties.
CfnIPAMPool(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIPAMPool(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIPAMPool(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIPAMPool(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AddressFamily
The address family of the pool.
public virtual string AddressFamily { get; set; }
Property Value
System.String
Remarks
AllocationDefaultNetmaskLength
The default netmask length for allocations added to this pool.
public virtual Nullable<double> AllocationDefaultNetmaskLength { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
AllocationMaxNetmaskLength
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
public virtual Nullable<double> AllocationMaxNetmaskLength { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationMinNetmaskLength
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
public virtual Nullable<double> AllocationMinNetmaskLength { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationResourceTags
Tags that are required for resources that use CIDRs from this IPAM pool.
public virtual object AllocationResourceTags { get; set; }
Property Value
System.Object
Remarks
Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
AttrArn
The ARN of the IPAM pool.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrIpamArn
The ARN of the IPAM.
public virtual string AttrIpamArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamArn
AttrIpamPoolId
The ID of the IPAM pool.
public virtual string AttrIpamPoolId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamPoolId
AttrIpamScopeArn
The ARN of the scope of the IPAM pool.
public virtual string AttrIpamScopeArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamScopeArn
AttrIpamScopeType
The scope of the IPAM.
public virtual string AttrIpamScopeType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamScopeType
AttrPoolDepth
The depth of pools in your IPAM pool.
public virtual double AttrPoolDepth { get; }
Property Value
System.Double
Remarks
The pool depth quota is 10.
CloudformationAttribute: PoolDepth
AttrState
The state of the IPAM pool.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
CloudformationAttribute: State
AttrStateMessage
A message related to the failed creation of an IPAM pool.
public virtual string AttrStateMessage { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StateMessage
AutoImport
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
public virtual object AutoImport { get; set; }
Property Value
System.Object
Remarks
The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
AwsService
Limits which service in AWS that the pool can be used in.
public virtual string AwsService { get; set; }
Property Value
System.String
Remarks
"ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the IPAM pool.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
IpamScopeId
The ID of the scope in which you would like to create the IPAM pool.
public virtual string IpamScopeId { get; set; }
Property Value
System.String
Remarks
Locale
The locale of the IPAM pool.
public virtual string Locale { get; set; }
Property Value
System.String
Remarks
In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
ProvisionedCidrs
Information about the CIDRs provisioned to an IPAM pool.
public virtual object ProvisionedCidrs { get; set; }
Property Value
System.Object
Remarks
PublicIpSource
The IP address source for pools in the public scope.
public virtual string PublicIpSource { get; set; }
Property Value
System.String
Remarks
Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .
PubliclyAdvertisable
Determines if a pool is publicly advertisable.
public virtual object PubliclyAdvertisable { get; set; }
Property Value
System.Object
Remarks
This option is not available for pools with AddressFamily set to ipv4
.
SourceIpamPoolId
The ID of the source IPAM pool.
public virtual string SourceIpamPoolId { get; set; }
Property Value
System.String
Remarks
You can use this option to create an IPAM pool within an existing source pool.
Tags
The key/value combination of a tag assigned to the resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>