Class CfnIPAM
A CloudFormation AWS::EC2::IPAM
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnIPAM : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnIPAM
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .
CloudformationResource: AWS::EC2::IPAM
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.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 cfnIPAM = new CfnIPAM(this, "MyCfnIPAM", new CfnIPAMProps {
DefaultResourceDiscoveryAssociationId = "defaultResourceDiscoveryAssociationId",
DefaultResourceDiscoveryId = "defaultResourceDiscoveryId",
Description = "description",
OperatingRegions = new [] { new IpamOperatingRegionProperty {
RegionName = "regionName"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnIPAM(Construct, String, ICfnIPAMProps) | Create a new |
CfnIPAM(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIPAM(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The ARN of the IPAM. |
AttrIpamId | The ID of the IPAM. |
AttrPrivateDefaultScopeId | The ID of the default private scope. |
AttrPublicDefaultScopeId | The ID of the default public scope. |
AttrResourceDiscoveryAssociationCount | The number of resource discovery associations. |
AttrScopeCount | The number of scopes. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DefaultResourceDiscoveryAssociationId | The IPAM's default resource discovery association ID. |
DefaultResourceDiscoveryId | The IPAM's default resource discovery ID. |
Description | The description for the IPAM. |
OperatingRegions | The operating Regions for an IPAM. |
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
CfnIPAM(Construct, String, ICfnIPAMProps)
Create a new AWS::EC2::IPAM
.
public CfnIPAM(Construct scope, string id, ICfnIPAMProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnIPAMProps
- resource properties.
CfnIPAM(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIPAM(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIPAM(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIPAM(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN of the IPAM.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrIpamId
The ID of the IPAM.
public virtual string AttrIpamId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamId
AttrPrivateDefaultScopeId
The ID of the default private scope.
public virtual string AttrPrivateDefaultScopeId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PrivateDefaultScopeId
AttrPublicDefaultScopeId
The ID of the default public scope.
public virtual string AttrPublicDefaultScopeId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: PublicDefaultScopeId
AttrResourceDiscoveryAssociationCount
The number of resource discovery associations.
public virtual double AttrResourceDiscoveryAssociationCount { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: ResourceDiscoveryAssociationCount
AttrScopeCount
The number of scopes.
public virtual double AttrScopeCount { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: ScopeCount
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
DefaultResourceDiscoveryAssociationId
The IPAM's default resource discovery association ID.
public virtual string DefaultResourceDiscoveryAssociationId { get; set; }
Property Value
System.String
Remarks
DefaultResourceDiscoveryId
The IPAM's default resource discovery ID.
public virtual string DefaultResourceDiscoveryId { get; set; }
Property Value
System.String
Remarks
Description
The description for the IPAM.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
OperatingRegions
The operating Regions for an IPAM.
public virtual object OperatingRegions { get; set; }
Property Value
System.Object
Remarks
Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .
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>