Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnIPAMScopePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnIPAMScopePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.446Z")
@Stability(Stable)
public class CfnIPAMScopePropsMixin
extends Mixin
implements software.constructs.IMixin

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

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ec2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnIPAMScopePropsMixin cfnIPAMScopePropsMixin = CfnIPAMScopePropsMixin.Builder.create(CfnIPAMScopeMixinProps.builder()
         .description("description")
         .externalAuthorityConfiguration(IpamScopeExternalAuthorityConfigurationProperty.builder()
                 .externalResourceIdentifier("externalResourceIdentifier")
                 .ipamScopeExternalAuthorityType("ipamScopeExternalAuthorityType")
                 .build())
         .ipamId("ipamId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnIPAMScopePropsMixin.Builder	A fluent builder for CfnIPAMScopePropsMixin.
static interface	CfnIPAMScopePropsMixin.IpamScopeExternalAuthorityConfigurationProperty	The configuration that links an Amazon VPC IPAM scope to an external authority system.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnIPAMScopePropsMixin(CfnIPAMScopeMixinProps props)	Create a mixin to apply properties to AWS::EC2::IPAMScope.
	CfnIPAMScopePropsMixin(CfnIPAMScopeMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::EC2::IPAMScope.
protected	CfnIPAMScopePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIPAMScopePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnIPAMScopeMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnIPAMScopePropsMixin

protected CfnIPAMScopePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnIPAMScopePropsMixin

protected CfnIPAMScopePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIPAMScopePropsMixin

@Stability(Stable)
public CfnIPAMScopePropsMixin(@NotNull
 CfnIPAMScopeMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::EC2::IPAMScope.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnIPAMScopePropsMixin

@Stability(Stable)
public CfnIPAMScopePropsMixin(@NotNull
 CfnIPAMScopeMixinProps props)

Create a mixin to apply properties to AWS::EC2::IPAMScope.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnIPAMScopeMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()