Package software.amazon.awscdk.services.ec2.alpha

Interface IpamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IpamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.419Z")
@Stability(Experimental)
public interface IpamProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to create a new Ipam in the account.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IpamProps.Builder	A builder for IpamProps
static final class	IpamProps.Jsii$Proxy	An implementation for IpamProps

Method Summary

Modifier and Type	Method	Description
static IpamProps.Builder	builder()
default String	getIpamName()	(experimental) Name of IPAM that can be used for tagging resource.
default List<String>	getOperatingRegion()	(experimental) The operating Regions for an IPAM.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpamName

@Stability(Experimental)
@Nullable
default String getIpamName()

(experimental) Name of IPAM that can be used for tagging resource.

Default: - If no name provided, no tags will be added to the IPAM

getOperatingRegion

@Stability(Experimental)
@Nullable
default List<String> getOperatingRegion()

(experimental) The operating Regions for an IPAM.

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

Default: - Stack.region if defined in the stack

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

builder

@Stability(Experimental)
static IpamProps.Builder builder()

Returns:

a IpamProps.Builder of IpamProps