Class CfnIPAMPool
In IPAM, a pool is a collection of contiguous IP addresses CIDRs.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIPAMPool : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnIPAMPool
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html
CloudformationResource: AWS::EC2::IPAMPool
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",
SourceResource = new SourceResourceProperty {
ResourceId = "resourceId",
ResourceOwner = "resourceOwner",
ResourceRegion = "resourceRegion",
ResourceType = "resourceType"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
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 |
CfnIPAMPool(Construct, String, ICfnIPAMPoolProps) |
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. |
SourceResource | The resource used to provision CIDRs to a resource planning pool. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnIPAMPool(Construct, String, ICfnIPAMPoolProps)
public CfnIPAMPool(Construct scope, string id, ICfnIPAMPoolProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnIPAMPoolProps
Resource properties.
Properties
AddressFamily
The address family of the pool.
public virtual string AddressFamily { get; set; }
Property Value
System.String
AllocationDefaultNetmaskLength
The default netmask length for allocations added to this pool.
public virtual Nullable<double> AllocationDefaultNetmaskLength { get; set; }
Property Value
System.Nullable<System.Double>
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>
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>
AllocationResourceTags
Tags that are required for resources that use CIDRs from this IPAM pool.
public virtual object AllocationResourceTags { get; set; }
Property Value
System.Object
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
AwsService
Limits which service in AWS that the pool can be used in.
public virtual string AwsService { get; set; }
Property Value
System.String
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
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
Locale
The locale of the IPAM pool.
public virtual string Locale { get; set; }
Property Value
System.String
ProvisionedCidrs
Information about the CIDRs provisioned to an IPAM pool.
public virtual object ProvisionedCidrs { get; set; }
Property Value
System.Object
PublicIpSource
The IP address source for pools in the public scope.
public virtual string PublicIpSource { get; set; }
Property Value
System.String
PubliclyAdvertisable
Determines if a pool is publicly advertisable.
public virtual object PubliclyAdvertisable { get; set; }
Property Value
System.Object
SourceIpamPoolId
The ID of the source IPAM pool.
public virtual string SourceIpamPoolId { get; set; }
Property Value
System.String
SourceResource
The resource used to provision CIDRs to a resource planning pool.
public virtual object SourceResource { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The key/value combination of a tag assigned to the resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>