Class CfnIPAMScope

In IPAM, a scope is the highest-level container within IPAM.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnIPAMScope

Implements

IInspectable

IIPAMScopeRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIPAMScope : CfnResource, IInspectable, IIPAMScopeRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnIPAMScope Inherits CfnResource Implements IInspectable, IIPAMScopeRef, IConstruct, IDependable, IEnvironmentAware, 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",
                 ExternalAuthorityConfiguration = new IpamScopeExternalAuthorityConfigurationProperty {
                     ExternalResourceIdentifier = "externalResourceIdentifier",
                     IpamScopeExternalAuthorityType = "ipamScopeExternalAuthorityType"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnIPAMScope(Construct, string, ICfnIPAMScopeProps)

Create a new AWS::EC2::IPAMScope.

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	In IPAM, a scope is the highest-level container within IPAM.
Description	The description of the scope.
ExternalAuthorityConfiguration	The configuration that links an Amazon VPC IPAM scope to an external authority system.
IpamId	The ID of the IPAM for which you're creating this scope.
IpamScopeRef	A reference to a IPAMScope resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The key/value combination of a tag assigned to the resource.

Methods

ArnForIPAMScope(IIPAMScopeRef)	In IPAM, a scope is the highest-level container within IPAM.
FromIPAMScopeArn(Construct, string, string)	Creates a new IIPAMScopeRef from an ARN.
FromIpamScopeId(Construct, string, string)	Creates a new IIPAMScopeRef from a ipamScopeId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnIPAMScope(object)	Checks whether the given object is a CfnIPAMScope.
RenderProperties(IDictionary<string, object>)	In IPAM, a scope is the highest-level container within IPAM.

Constructors

CfnIPAMScope(Construct, string, ICfnIPAMScopeProps)

Create a new AWS::EC2::IPAMScope.

public CfnIPAMScope(Construct scope, string id, ICfnIPAMScopeProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnIPAMScopeProps

Resource properties.

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

Properties

AttrArn

The ARN of the scope.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrIpamArn

The ARN of an IPAM.

public virtual string AttrIpamArn { get; }

Property Value

string

Remarks

CloudformationAttribute: IpamArn

AttrIpamScopeId

The ID of an IPAM scope.

public virtual string AttrIpamScopeId { get; }

Property Value

string

Remarks

CloudformationAttribute: IpamScopeId

AttrIpamScopeType

The type of the scope.

public virtual string AttrIpamScopeType { get; }

Property Value

string

Remarks

CloudformationAttribute: IpamScopeType

AttrIsDefault

Defines if the scope is the default scope or not.

public virtual IResolvable AttrIsDefault { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: IsDefault

AttrPoolCount

The number of pools in a scope.

public virtual double AttrPoolCount { get; }

Property Value

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

string

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

CfnProperties

In IPAM, a scope is the highest-level container within IPAM.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

Description

The description of the scope.

public virtual string? Description { get; set; }

Property Value

string

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

ExternalAuthorityConfiguration

The configuration that links an Amazon VPC IPAM scope to an external authority system.

public virtual object? ExternalAuthorityConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnIPAMScope.IIpamScopeExternalAuthorityConfigurationProperty

IpamId

The ID of the IPAM for which you're creating this scope.

public virtual string IpamId { get; set; }

Property Value

string

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

IpamScopeRef

A reference to a IPAMScope resource.

public virtual IIPAMScopeReference IpamScopeRef { get; }

Property Value

IIPAMScopeReference

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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

TagsRaw

The key/value combination of a tag assigned to the resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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

Methods

ArnForIPAMScope(IIPAMScopeRef)

In IPAM, a scope is the highest-level container within IPAM.

public static string ArnForIPAMScope(IIPAMScopeRef resource)

Parameters

resource IIPAMScopeRef

Returns

string

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",
                 ExternalAuthorityConfiguration = new IpamScopeExternalAuthorityConfigurationProperty {
                     ExternalResourceIdentifier = "externalResourceIdentifier",
                     IpamScopeExternalAuthorityType = "ipamScopeExternalAuthorityType"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromIPAMScopeArn(Construct, string, string)

Creates a new IIPAMScopeRef from an ARN.

public static IIPAMScopeRef FromIPAMScopeArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IIPAMScopeRef

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

FromIpamScopeId(Construct, string, string)

Creates a new IIPAMScopeRef from a ipamScopeId.

public static IIPAMScopeRef FromIpamScopeId(Construct scope, string id, string ipamScopeId)

Parameters

scope Construct

id string

ipamScopeId string

Returns

IIPAMScopeRef

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

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.

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

IsCfnIPAMScope(object)

Checks whether the given object is a CfnIPAMScope.

public static bool IsCfnIPAMScope(object x)

Parameters

x object

Returns

bool

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

RenderProperties(IDictionary<string, object>)

In IPAM, a scope is the highest-level container within IPAM.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable

IIPAMScopeRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable