Show / Hide Table of Contents

Class CfnIPAMPoolCidr

A CloudFormation AWS::EC2::IPAMPoolCidr.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnIPAMPoolCidr
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnIPAMPoolCidr : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnIPAMPoolCidr
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

A CIDR provisioned to an IPAM pool.

CloudformationResource: AWS::EC2::IPAMPoolCidr

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.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 cfnIPAMPoolCidr = new CfnIPAMPoolCidr(this, "MyCfnIPAMPoolCidr", new CfnIPAMPoolCidrProps {
    IpamPoolId = "ipamPoolId",

    // the properties below are optional
    Cidr = "cidr",
    NetmaskLength = 123
});

Synopsis

Constructors

CfnIPAMPoolCidr(Construct, String, ICfnIPAMPoolCidrProps)

Create a new AWS::EC2::IPAMPoolCidr.

CfnIPAMPoolCidr(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnIPAMPoolCidr(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrIpamPoolCidrId

The IPAM pool CIDR ID.

AttrState

The state of the CIDR.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
Cidr

The CIDR provisioned to the IPAM pool.

IpamPoolId

The ID of the IPAM pool.

NetmaskLength

The netmask length of the CIDR you'd like to provision to a pool.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnIPAMPoolCidr(Construct, String, ICfnIPAMPoolCidrProps)

Create a new AWS::EC2::IPAMPoolCidr.

public CfnIPAMPoolCidr(Construct scope, string id, ICfnIPAMPoolCidrProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnIPAMPoolCidrProps
  • resource properties.

CfnIPAMPoolCidr(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnIPAMPoolCidr(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnIPAMPoolCidr(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnIPAMPoolCidr(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrIpamPoolCidrId

The IPAM pool CIDR ID.

public virtual string AttrIpamPoolCidrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: IpamPoolCidrId

AttrState

The state of the CIDR.

public virtual string AttrState { get; }
Property Value

System.String

Remarks

CloudformationAttribute: State

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
CfnResource.CfnProperties

Cidr

The CIDR provisioned to the IPAM pool.

public virtual string Cidr { get; set; }
Property Value

System.String

Remarks

A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-cidr

IpamPoolId

The ID of the IPAM pool.

public virtual string IpamPoolId { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-ipampoolid

NetmaskLength

The netmask length of the CIDR you'd like to provision to a pool.

public virtual Nullable<double> NetmaskLength { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html#cfn-ec2-ipampoolcidr-netmasklength

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>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct
Constructs.IConstruct
IDependable
IInspectable
Back to top Generated by DocFX