Package com.pulumi.aws.ec2

Class VpcIpamResourceDiscovery

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.ec2.VpcIpamResourceDiscovery

public class VpcIpamResourceDiscovery
extends com.pulumi.resources.CustomResource

Provides an IPAM Resource Discovery resource. IPAM Resource Discoveries are resources meant for multi-organization customers. If you wish to use a single IPAM across multiple orgs, a resource discovery can be created and shared from a subordinate organization to the management organizations IPAM delegated admin account. For a full deployment example, see `aws.ec2.VpcIpamResourceDiscoveryAssociation` resource. ## Example Usage Basic usage: <!--Start PulumiCodeChooser -->

 
 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.VpcIpamResourceDiscovery;
 import com.pulumi.aws.ec2.VpcIpamResourceDiscoveryArgs;
 import com.pulumi.aws.ec2.inputs.VpcIpamResourceDiscoveryOperatingRegionArgs;
 import java.util.List;
 import java.util.ArrayList;
 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();
 
         var main = new VpcIpamResourceDiscovery("main", VpcIpamResourceDiscoveryArgs.builder()        
             .description("My IPAM Resource Discovery")
             .operatingRegions(VpcIpamResourceDiscoveryOperatingRegionArgs.builder()
                 .regionName(current.applyValue(getRegionResult -> getRegionResult.name()))
                 .build())
             .tags(Map.of("Test", "Main"))
             .build());
 
     }
 }
 
 

<!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import IPAMs using the IPAM resource discovery `id`. For example: ```sh $ pulumi import aws:ec2/vpcIpamResourceDiscovery:VpcIpamResourceDiscovery example ipam-res-disco-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
VpcIpamResourceDiscovery(java.lang.String name)
VpcIpamResourceDiscovery(java.lang.String name, VpcIpamResourceDiscoveryArgs args)
VpcIpamResourceDiscovery(java.lang.String name, VpcIpamResourceDiscoveryArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	arn()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	description()
static VpcIpamResourceDiscovery	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VpcIpamResourceDiscoveryState 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>	ipamResourceDiscoveryRegion()
com.pulumi.core.Output<java.lang.Boolean>	isDefault()
com.pulumi.core.Output<java.util.List<VpcIpamResourceDiscoveryOperatingRegion>>	operatingRegions()
com.pulumi.core.Output<java.lang.String>	ownerId()
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

VpcIpamResourceDiscovery

public VpcIpamResourceDiscovery(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

VpcIpamResourceDiscovery

public VpcIpamResourceDiscovery(java.lang.String name,
                                VpcIpamResourceDiscoveryArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

VpcIpamResourceDiscovery

public VpcIpamResourceDiscovery(java.lang.String name,
                                VpcIpamResourceDiscoveryArgs 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:

Amazon Resource Name (ARN) of IPAM Resource Discovery

description

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()

Returns:

A description for the IPAM Resource Discovery.

ipamResourceDiscoveryRegion

public com.pulumi.core.Output<java.lang.String> ipamResourceDiscoveryRegion()

Returns:

The home region of the Resource Discovery

isDefault

public com.pulumi.core.Output<java.lang.Boolean> isDefault()

Returns:

A boolean to identify if the Resource Discovery is the accounts default resource discovery

operatingRegions

public com.pulumi.core.Output<java.util.List<VpcIpamResourceDiscoveryOperatingRegion>> operatingRegions()

Returns:

Determines which regions the Resource Discovery will enable IPAM features for usage and monitoring. 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 Resource Discovery. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the region_name parameter. **You must set your provider block region as an operating_region.**

ownerId

public com.pulumi.core.Output<java.lang.String> ownerId()

Returns:

The account ID for the account that manages the Resource Discovery

tags

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

A map of tags to assign to the resource. If configured with a provider `default_tags` 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:

A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

get

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