Package com.pulumi.aws.ec2

Class VpcIpamPoolCidrAllocation

  • public class VpcIpamPoolCidrAllocation
extends com.pulumi.resources.CustomResource
    Allocates (reserves) a CIDR from an IPAM address pool, preventing usage by IPAM. Only works for private IPv4. ## Example Usage Basic usage: 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetRegionArgs;
 import com.pulumi.aws.ec2.VpcIpam;
 import com.pulumi.aws.ec2.VpcIpamArgs;
 import com.pulumi.aws.ec2.inputs.VpcIpamOperatingRegionArgs;
 import com.pulumi.aws.ec2.VpcIpamPool;
 import com.pulumi.aws.ec2.VpcIpamPoolArgs;
 import com.pulumi.aws.ec2.VpcIpamPoolCidr;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrArgs;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocation;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocationArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         final var current = AwsFunctions.getRegion(GetRegionArgs.builder()
             .build());
 
         var exampleVpcIpam = new VpcIpam("exampleVpcIpam", VpcIpamArgs.builder()
             .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                 .regionName(current.region())
                 .build())
             .build());
 
         var exampleVpcIpamPool = new VpcIpamPool("exampleVpcIpamPool", VpcIpamPoolArgs.builder()
             .addressFamily("ipv4")
             .ipamScopeId(exampleVpcIpam.privateDefaultScopeId())
             .locale(current.region())
             .build());
 
         var exampleVpcIpamPoolCidr = new VpcIpamPoolCidr("exampleVpcIpamPoolCidr", VpcIpamPoolCidrArgs.builder()
             .ipamPoolId(exampleVpcIpamPool.id())
             .cidr("172.20.0.0/16")
             .build());
 
         var example = new VpcIpamPoolCidrAllocation("example", VpcIpamPoolCidrAllocationArgs.builder()
             .ipamPoolId(exampleVpcIpamPool.id())
             .cidr("172.20.0.0/24")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleVpcIpamPoolCidr)
                 .build());
 
     }
 }
    With the `disallowedCidrs` attribute: 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetRegionArgs;
 import com.pulumi.aws.ec2.VpcIpam;
 import com.pulumi.aws.ec2.VpcIpamArgs;
 import com.pulumi.aws.ec2.inputs.VpcIpamOperatingRegionArgs;
 import com.pulumi.aws.ec2.VpcIpamPool;
 import com.pulumi.aws.ec2.VpcIpamPoolArgs;
 import com.pulumi.aws.ec2.VpcIpamPoolCidr;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrArgs;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocation;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocationArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         final var current = AwsFunctions.getRegion(GetRegionArgs.builder()
             .build());
 
         var exampleVpcIpam = new VpcIpam("exampleVpcIpam", VpcIpamArgs.builder()
             .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                 .regionName(current.region())
                 .build())
             .build());
 
         var exampleVpcIpamPool = new VpcIpamPool("exampleVpcIpamPool", VpcIpamPoolArgs.builder()
             .addressFamily("ipv4")
             .ipamScopeId(exampleVpcIpam.privateDefaultScopeId())
             .locale(current.region())
             .build());
 
         var exampleVpcIpamPoolCidr = new VpcIpamPoolCidr("exampleVpcIpamPoolCidr", VpcIpamPoolCidrArgs.builder()
             .ipamPoolId(exampleVpcIpamPool.id())
             .cidr("172.20.0.0/16")
             .build());
 
         var example = new VpcIpamPoolCidrAllocation("example", VpcIpamPoolCidrAllocationArgs.builder()
             .ipamPoolId(exampleVpcIpamPool.id())
             .netmaskLength(28)
             .disallowedCidrs("172.20.0.0/28")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleVpcIpamPoolCidr)
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import IPAM allocations using the allocation `id` and `pool id`, separated by `_`. For example: ```sh $ pulumi import aws:ec2/vpcIpamPoolCidrAllocation:VpcIpamPoolCidrAllocation example ipam-pool-alloc-0dc6d196509c049ba8b549ff99f639736_ipam-pool-07cfb559e0921fcbe ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> cidr()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> disallowedCidrs()  
      static VpcIpamPoolCidrAllocation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VpcIpamPoolCidrAllocationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> ipamPoolAllocationId()  
      com.pulumi.core.Output<java.lang.String> ipamPoolId()  
      com.pulumi.core.Output<java.lang.Integer> netmaskLength()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceId()  
      com.pulumi.core.Output<java.lang.String> resourceOwner()  
      com.pulumi.core.Output<java.lang.String> resourceType()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • VpcIpamPoolCidrAllocation

        public VpcIpamPoolCidrAllocation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • VpcIpamPoolCidrAllocation

        public VpcIpamPoolCidrAllocation​(java.lang.String name,
                                 VpcIpamPoolCidrAllocationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • VpcIpamPoolCidrAllocation

        public VpcIpamPoolCidrAllocation​(java.lang.String name,
                                 VpcIpamPoolCidrAllocationArgs args,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • cidr

        public com.pulumi.core.Output<java.lang.String> cidr()
        Returns:
        CIDR you want to assign to the pool.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the allocation.

      • disallowedCidrs

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> disallowedCidrs()
        Returns:
        Exclude a particular CIDR range from being returned by the pool.

      • ipamPoolAllocationId

        public com.pulumi.core.Output<java.lang.String> ipamPoolAllocationId()
        Returns:
        ID of the allocation.

      • ipamPoolId

        public com.pulumi.core.Output<java.lang.String> ipamPoolId()
        Returns:
        ID of the pool to which you want to assign a CIDR.

      • netmaskLength

        public com.pulumi.core.Output<java.lang.Integer> netmaskLength()
        Returns:
        Netmask length of the CIDR you would like to allocate to the IPAM pool. Valid Values: `0-128`.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • resourceId

        public com.pulumi.core.Output<java.lang.String> resourceId()
        Returns:
        ID of the resource.

      • resourceOwner

        public com.pulumi.core.Output<java.lang.String> resourceOwner()
        Returns:
        Owner of the resource.

      • resourceType

        public com.pulumi.core.Output<java.lang.String> resourceType()
        Returns:
        Type of the resource.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static VpcIpamPoolCidrAllocation get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            VpcIpamPoolCidrAllocationState state,
                                            @Nullable
                                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.