Class Ipam
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.ec2.alpha.Ipam
- All Implemented Interfaces:
IResource
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:11.417Z")
@Stability(Experimental)
public class Ipam
extends Resource
(experimental) Creates new IPAM with default public and private scope.
Example:
Stack stack = new Stack(); Ipam ipam = Ipam.Builder.create(this, "Ipam") .operatingRegion(List.of("us-west-1")) .build(); IIpamPool ipamPublicPool = ipam.publicScope.addPool("PublicPoolA", PoolOptions.builder() .addressFamily(AddressFamily.IP_V6) .awsService(AwsServiceName.EC2) .locale("us-west-1") .publicIpSource(IpamPoolPublicIpSource.AMAZON) .build()); ipamPublicPool.provisionCidr("PublicPoolACidrA", IpamPoolCidrProvisioningOptions.builder().netmaskLength(52).build()); IIpamPool ipamPrivatePool = ipam.privateScope.addPool("PrivatePoolA", PoolOptions.builder() .addressFamily(AddressFamily.IP_V4) .build()); ipamPrivatePool.provisionCidr("PrivatePoolACidrA", IpamPoolCidrProvisioningOptions.builder().netmaskLength(8).build()); VpcV2.Builder.create(this, "Vpc") .primaryAddressBlock(IpAddresses.ipv4("10.0.0.0/24")) .secondaryAddressBlocks(List.of(IpAddresses.amazonProvidedIpv6(SecondaryAddressProps.builder().cidrBlockName("AmazonIpv6").build()), IpAddresses.ipv6Ipam(IpamOptions.builder() .ipamPool(ipamPublicPool) .netmaskLength(52) .cidrBlockName("ipv6Ipam") .build()), IpAddresses.ipv4Ipam(IpamOptions.builder() .ipamPool(ipamPrivatePool) .netmaskLength(8) .cidrBlockName("ipv4Ipam") .build()))) .build();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddScope
(software.constructs.Construct scope, String id, IpamScopeOptions options) (experimental) Function to add custom scope to an existing IPAM Custom scopes can only be private.(experimental) Access to Ipam resource id that can be used later to add a custom private scope to this IPAM.(experimental) List of operating regions for IPAM.(experimental) Provides access to default private IPAM scope through add pool method.(experimental) Provides access to default public IPAM scope through add pool method.(experimental) List of scopes created under this IPAM.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Ipam
protected Ipam(software.amazon.jsii.JsiiObjectRef objRef) -
Ipam
protected Ipam(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Ipam
@Stability(Experimental) public Ipam(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable IpamProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
-
-
Ipam
@Stability(Experimental) public Ipam(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
addScope
@Stability(Experimental) @NotNull public IIpamScopeBase addScope(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull IpamScopeOptions options) (experimental) Function to add custom scope to an existing IPAM Custom scopes can only be private.- Parameters:
scope
- This parameter is required.id
- This parameter is required.options
- This parameter is required.
-
getIpamId
(experimental) Access to Ipam resource id that can be used later to add a custom private scope to this IPAM. -
getOperatingRegions
(experimental) List of operating regions for IPAM. -
getPrivateScope
(experimental) Provides access to default private IPAM scope through add pool method.Usage: To add an Ipam Pool to a default private scope
- See Also:
-
getPublicScope
(experimental) Provides access to default public IPAM scope through add pool method.Usage: To add an Ipam Pool to a default public scope
- See Also:
-
getScopes
(experimental) List of scopes created under this IPAM.
-