Class CfnIPAMScope
In IPAM, a scope is the highest-level container within IPAM.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIPAMScope : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnIPAMScope
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html
CloudformationResource: AWS::EC2::IPAMScope
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 cfnIPAMScope = new CfnIPAMScope(this, "MyCfnIPAMScope", new CfnIPAMScopeProps {
IpamId = "ipamId",
// the properties below are optional
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnIPAMScope(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnIPAMScope(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnIPAMScope(Construct, String, ICfnIPAMScopeProps) |
Properties
AttrArn | The ARN of the scope. |
AttrIpamArn | The ARN of an IPAM. |
AttrIpamScopeId | The ID of an IPAM scope. |
AttrIpamScopeType | The type of the scope. |
AttrIsDefault | Defines if the scope is the default scope or not. |
AttrPoolCount | The number of pools in a scope. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the scope. |
IpamId | The ID of the IPAM for which you're creating this scope. |
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
CfnIPAMScope(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnIPAMScope(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnIPAMScope(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnIPAMScope(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnIPAMScope(Construct, String, ICfnIPAMScopeProps)
public CfnIPAMScope(Construct scope, string id, ICfnIPAMScopeProps 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 ICfnIPAMScopeProps
Resource properties.
Properties
AttrArn
The ARN of the scope.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrIpamArn
The ARN of an IPAM.
public virtual string AttrIpamArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamArn
AttrIpamScopeId
The ID of an IPAM scope.
public virtual string AttrIpamScopeId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamScopeId
AttrIpamScopeType
The type of the scope.
public virtual string AttrIpamScopeType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IpamScopeType
AttrIsDefault
Defines if the scope is the default scope or not.
public virtual IResolvable AttrIsDefault { get; }
Property Value
Remarks
CloudformationAttribute: IsDefault
AttrPoolCount
The number of pools in a scope.
public virtual double AttrPoolCount { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: PoolCount
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 scope.
public virtual string Description { get; set; }
Property Value
System.String
IpamId
The ID of the IPAM for which you're creating this scope.
public virtual string IpamId { get; set; }
Property Value
System.String
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>