Package com.pulumi.aws.ec2

Class VpcIpam

  • public class VpcIpam
extends com.pulumi.resources.CustomResource
    Provides an IPAM resource. ## 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 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 main = new VpcIpam("main", VpcIpamArgs.builder()
             .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                 .regionName(current.region())
                 .build())
             .description("My IPAM")
             .tags(Map.of("Test", "Main"))
             .build());
 
     }
 }
    Shared with multiple operating_regions: ## Import Using `pulumi import`, import IPAMs using the IPAM `id`. For example: ```sh $ pulumi import aws:ec2/vpcIpam:VpcIpam example ipam-0178368ad2146a492 ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      VpcIpam​(java.lang.String name)  
      VpcIpam​(java.lang.String name, VpcIpamArgs args)  
      VpcIpam​(java.lang.String name, VpcIpamArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> cascade()  
      com.pulumi.core.Output<java.lang.String> defaultResourceDiscoveryAssociationId()  
      com.pulumi.core.Output<java.lang.String> defaultResourceDiscoveryId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePrivateGua()  
      static VpcIpam get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VpcIpamState 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> meteredAccount()  
      com.pulumi.core.Output<java.util.List<VpcIpamOperatingRegion>> operatingRegions()  
      com.pulumi.core.Output<java.lang.String> privateDefaultScopeId()  
      com.pulumi.core.Output<java.lang.String> publicDefaultScopeId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Integer> scopeCount()  
      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()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tier()  

      • 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

      • VpcIpam

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

      • VpcIpam

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

      • VpcIpam

        public VpcIpam​(java.lang.String name,
               VpcIpamArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of IPAM

      • cascade

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> cascade()
        Returns:
        Whether to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.

      • defaultResourceDiscoveryAssociationId

        public com.pulumi.core.Output<java.lang.String> defaultResourceDiscoveryAssociationId()
        Returns:
        IPAM's default resource discovery association ID.

      • defaultResourceDiscoveryId

        public com.pulumi.core.Output<java.lang.String> defaultResourceDiscoveryId()
        Returns:
        IPAM's default resource discovery ID.

      • description

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

      • enablePrivateGua

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enablePrivateGua()
        Returns:
        Whether to use your own GUA ranges as private IPv6 addresses. Default: `false`.

      • meteredAccount

        public com.pulumi.core.Output<java.lang.String> meteredAccount()
        Returns:
        AWS account that is charged for active IP addresses managed in IPAM. Valid values are `ipam-owner` (default) and `resource-owner`.

      • operatingRegions

        public com.pulumi.core.Output<java.util.List<VpcIpamOperatingRegion>> operatingRegions()
        Returns:
        Locales that can be chosen when you create pools. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the regionName parameter. You **must** set your provider block region as an operating_region.

      • privateDefaultScopeId

        public com.pulumi.core.Output<java.lang.String> privateDefaultScopeId()
        Returns:
        ID of the IPAM's private scope. A scope is a top-level container in IPAM. Each scope represents an IP-independent network. Scopes enable you to represent networks where you have overlapping IP space. When you create an IPAM, IPAM automatically creates two scopes: public and private. The private scope is intended for private IP space. The public scope is intended for all internet-routable IP space.

      • publicDefaultScopeId

        public com.pulumi.core.Output<java.lang.String> publicDefaultScopeId()
        Returns:
        ID of the IPAM's public scope. A scope is a top-level container in IPAM. Each scope represents an IP-independent network. Scopes enable you to represent networks where you have overlapping IP space. When you create an IPAM, IPAM automatically creates two scopes: public and private. The private scope is intended for private IP space. The public scope is intended for all internet-routable IP space.

      • 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.

      • scopeCount

        public com.pulumi.core.Output<java.lang.Integer> scopeCount()
        Returns:
        Number of scopes in the IPAM.

      • 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.

      • tier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tier()
        Returns:
        specifies the IPAM tier. Valid options include `free` and `advanced`. Default is `advanced`.

      • get

        public static VpcIpam get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          VpcIpamState 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.