Class CfnIPAMAllocation
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIPAMAllocation : CfnResource, IInspectable
Syntax (vb)
Public Class CfnIPAMAllocation
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html
CloudformationResource: AWS::EC2::IPAMAllocation
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 cfnIPAMAllocation = new CfnIPAMAllocation(this, "MyCfnIPAMAllocation", new CfnIPAMAllocationProps {
IpamPoolId = "ipamPoolId",
// the properties below are optional
Cidr = "cidr",
Description = "description",
NetmaskLength = 123
});
Synopsis
Constructors
CfnIPAMAllocation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIPAMAllocation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnIPAMAllocation(Construct, String, ICfnIPAMAllocationProps) |
Properties
AttrIpamPoolAllocationId | The ID of an allocation. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Cidr | The CIDR you would like to allocate from the IPAM pool. |
Description | A description for the allocation. |
IpamPoolId | The ID of the IPAM pool from which you would like to allocate a CIDR. |
NetmaskLength | The netmask length of the CIDR you would like to allocate from the IPAM pool. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnIPAMAllocation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIPAMAllocation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIPAMAllocation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIPAMAllocation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnIPAMAllocation(Construct, String, ICfnIPAMAllocationProps)
public CfnIPAMAllocation(Construct scope, string id, ICfnIPAMAllocationProps 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 ICfnIPAMAllocationProps
Resource properties.
Properties
AttrIpamPoolAllocationId
The ID of an allocation.
public virtual string AttrIpamPoolAllocationId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamPoolAllocationId
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
Cidr
The CIDR you would like to allocate from the IPAM pool.
public virtual string Cidr { get; set; }
Property Value
System.String
Remarks
Note the following:.
Description
A description for the allocation.
public virtual string Description { get; set; }
Property Value
System.String
IpamPoolId
The ID of the IPAM pool from which you would like to allocate a CIDR.
public virtual string IpamPoolId { get; set; }
Property Value
System.String
NetmaskLength
The netmask length of the CIDR you would like to allocate from the IPAM pool.
public virtual Nullable<double> NetmaskLength { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Note the following:.
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>