Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. VpcIpamResourceDiscoveryAssociation
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.VpcIpamResourceDiscoveryAssociation

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

Provides an association between an Amazon IP Address Manager (IPAM) and a IPAM Resource Discovery. 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.

Once an association is created between two organizations via IPAM & a IPAM Resource Discovery, IPAM Pools can be shared via Resource Access Manager (RAM) to accounts in the subordinate organization; these RAM shares must be accepted by the end user account. Pools can then also discover and monitor IPAM resources in the subordinate organization.

Example Usage

Basic usage:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.ec2.VpcIpamResourceDiscoveryAssociation("test", {
    ipamId: testAwsVpcIpam.id,
    ipamResourceDiscoveryId: testAwsVpcIpamResourceDiscovery.id,
    tags: {
        Name: "test",
    },
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.ec2.VpcIpamResourceDiscoveryAssociation("test",
    ipam_id=test_aws_vpc_ipam["id"],
    ipam_resource_discovery_id=test_aws_vpc_ipam_resource_discovery["id"],
    tags={
        "Name": "test",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewVpcIpamResourceDiscoveryAssociation(ctx, "test", &ec2.VpcIpamResourceDiscoveryAssociationArgs{
			IpamId:                  pulumi.Any(testAwsVpcIpam.Id),
			IpamResourceDiscoveryId: pulumi.Any(testAwsVpcIpamResourceDiscovery.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Ec2.VpcIpamResourceDiscoveryAssociation("test", new()
    {
        IpamId = testAwsVpcIpam.Id,
        IpamResourceDiscoveryId = testAwsVpcIpamResourceDiscovery.Id,
        Tags = 
        {
            { "Name", "test" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.VpcIpamResourceDiscoveryAssociation;
import com.pulumi.aws.ec2.VpcIpamResourceDiscoveryAssociationArgs;
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) {
        var test = new VpcIpamResourceDiscoveryAssociation("test", VpcIpamResourceDiscoveryAssociationArgs.builder()
            .ipamId(testAwsVpcIpam.id())
            .ipamResourceDiscoveryId(testAwsVpcIpamResourceDiscovery.id())
            .tags(Map.of("Name", "test"))
            .build());

    }
}
Copy
resources:
  test:
    type: aws:ec2:VpcIpamResourceDiscoveryAssociation
    properties:
      ipamId: ${testAwsVpcIpam.id}
      ipamResourceDiscoveryId: ${testAwsVpcIpamResourceDiscovery.id}
      tags:
        Name: test
Copy

Create VpcIpamResourceDiscoveryAssociation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VpcIpamResourceDiscoveryAssociation(name: string, args: VpcIpamResourceDiscoveryAssociationArgs, opts?: CustomResourceOptions);
@overload
def VpcIpamResourceDiscoveryAssociation(resource_name: str,
                                        args: VpcIpamResourceDiscoveryAssociationArgs,
                                        opts: Optional[ResourceOptions] = None)

@overload
def VpcIpamResourceDiscoveryAssociation(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        ipam_id: Optional[str] = None,
                                        ipam_resource_discovery_id: Optional[str] = None,
                                        tags: Optional[Mapping[str, str]] = None)
func NewVpcIpamResourceDiscoveryAssociation(ctx *Context, name string, args VpcIpamResourceDiscoveryAssociationArgs, opts ...ResourceOption) (*VpcIpamResourceDiscoveryAssociation, error)
public VpcIpamResourceDiscoveryAssociation(string name, VpcIpamResourceDiscoveryAssociationArgs args, CustomResourceOptions? opts = null)
public VpcIpamResourceDiscoveryAssociation(String name, VpcIpamResourceDiscoveryAssociationArgs args)
public VpcIpamResourceDiscoveryAssociation(String name, VpcIpamResourceDiscoveryAssociationArgs args, CustomResourceOptions options)

type: aws:ec2:VpcIpamResourceDiscoveryAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VpcIpamResourceDiscoveryAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VpcIpamResourceDiscoveryAssociationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VpcIpamResourceDiscoveryAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VpcIpamResourceDiscoveryAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpcIpamResourceDiscoveryAssociationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var vpcIpamResourceDiscoveryAssociationResource = new Aws.Ec2.VpcIpamResourceDiscoveryAssociation("vpcIpamResourceDiscoveryAssociationResource", new()
{
    IpamId = "string",
    IpamResourceDiscoveryId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ec2.NewVpcIpamResourceDiscoveryAssociation(ctx, "vpcIpamResourceDiscoveryAssociationResource", &ec2.VpcIpamResourceDiscoveryAssociationArgs{
	IpamId:                  pulumi.String("string"),
	IpamResourceDiscoveryId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var vpcIpamResourceDiscoveryAssociationResource = new VpcIpamResourceDiscoveryAssociation("vpcIpamResourceDiscoveryAssociationResource", VpcIpamResourceDiscoveryAssociationArgs.builder()
    .ipamId("string")
    .ipamResourceDiscoveryId("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
vpc_ipam_resource_discovery_association_resource = aws.ec2.VpcIpamResourceDiscoveryAssociation("vpcIpamResourceDiscoveryAssociationResource",
    ipam_id="string",
    ipam_resource_discovery_id="string",
    tags={
        "string": "string",
    })
Copy
const vpcIpamResourceDiscoveryAssociationResource = new aws.ec2.VpcIpamResourceDiscoveryAssociation("vpcIpamResourceDiscoveryAssociationResource", {
    ipamId: "string",
    ipamResourceDiscoveryId: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:ec2:VpcIpamResourceDiscoveryAssociation
properties:
    ipamId: string
    ipamResourceDiscoveryId: string
    tags:
        string: string
Copy

VpcIpamResourceDiscoveryAssociation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VpcIpamResourceDiscoveryAssociation resource accepts the following input properties:

IpamId This property is required. string
The ID of the IPAM to associate.
IpamResourceDiscoveryId This property is required. string
The ID of the Resource Discovery to associate.
Tags Dictionary<string, string>
A map of tags to add to the IPAM resource discovery association resource.
IpamId This property is required. string
The ID of the IPAM to associate.
IpamResourceDiscoveryId This property is required. string
The ID of the Resource Discovery to associate.
Tags map[string]string
A map of tags to add to the IPAM resource discovery association resource.
ipamId This property is required. String
The ID of the IPAM to associate.
ipamResourceDiscoveryId This property is required. String
The ID of the Resource Discovery to associate.
tags Map<String,String>
A map of tags to add to the IPAM resource discovery association resource.
ipamId This property is required. string
The ID of the IPAM to associate.
ipamResourceDiscoveryId This property is required. string
The ID of the Resource Discovery to associate.
tags {[key: string]: string}
A map of tags to add to the IPAM resource discovery association resource.
ipam_id This property is required. str
The ID of the IPAM to associate.
ipam_resource_discovery_id This property is required. str
The ID of the Resource Discovery to associate.
tags Mapping[str, str]
A map of tags to add to the IPAM resource discovery association resource.
ipamId This property is required. String
The ID of the IPAM to associate.
ipamResourceDiscoveryId This property is required. String
The ID of the Resource Discovery to associate.
tags Map<String>
A map of tags to add to the IPAM resource discovery association resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpcIpamResourceDiscoveryAssociation resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
Id string
The provider-assigned unique ID for this managed resource.
IpamArn string
The Amazon Resource Name (ARN) of the IPAM.
IpamRegion string
The home region of the IPAM.
IsDefault bool
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
OwnerId string
The account ID for the account that manages the Resource Discovery
State string
The lifecycle state of the association when you associate or disassociate a resource discovery.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
Id string
The provider-assigned unique ID for this managed resource.
IpamArn string
The Amazon Resource Name (ARN) of the IPAM.
IpamRegion string
The home region of the IPAM.
IsDefault bool
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
OwnerId string
The account ID for the account that manages the Resource Discovery
State string
The lifecycle state of the association when you associate or disassociate a resource discovery.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
id String
The provider-assigned unique ID for this managed resource.
ipamArn String
The Amazon Resource Name (ARN) of the IPAM.
ipamRegion String
The home region of the IPAM.
isDefault Boolean
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
ownerId String
The account ID for the account that manages the Resource Discovery
state String
The lifecycle state of the association when you associate or disassociate a resource discovery.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
id string
The provider-assigned unique ID for this managed resource.
ipamArn string
The Amazon Resource Name (ARN) of the IPAM.
ipamRegion string
The home region of the IPAM.
isDefault boolean
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
ownerId string
The account ID for the account that manages the Resource Discovery
state string
The lifecycle state of the association when you associate or disassociate a resource discovery.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
id str
The provider-assigned unique ID for this managed resource.
ipam_arn str
The Amazon Resource Name (ARN) of the IPAM.
ipam_region str
The home region of the IPAM.
is_default bool
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
owner_id str
The account ID for the account that manages the Resource Discovery
state str
The lifecycle state of the association when you associate or disassociate a resource discovery.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
id String
The provider-assigned unique ID for this managed resource.
ipamArn String
The Amazon Resource Name (ARN) of the IPAM.
ipamRegion String
The home region of the IPAM.
isDefault Boolean
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
ownerId String
The account ID for the account that manages the Resource Discovery
state String
The lifecycle state of the association when you associate or disassociate a resource discovery.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing VpcIpamResourceDiscoveryAssociation Resource

Get an existing VpcIpamResourceDiscoveryAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpcIpamResourceDiscoveryAssociationState, opts?: CustomResourceOptions): VpcIpamResourceDiscoveryAssociation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        ipam_arn: Optional[str] = None,
        ipam_id: Optional[str] = None,
        ipam_region: Optional[str] = None,
        ipam_resource_discovery_id: Optional[str] = None,
        is_default: Optional[bool] = None,
        owner_id: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> VpcIpamResourceDiscoveryAssociation
func GetVpcIpamResourceDiscoveryAssociation(ctx *Context, name string, id IDInput, state *VpcIpamResourceDiscoveryAssociationState, opts ...ResourceOption) (*VpcIpamResourceDiscoveryAssociation, error)
public static VpcIpamResourceDiscoveryAssociation Get(string name, Input<string> id, VpcIpamResourceDiscoveryAssociationState? state, CustomResourceOptions? opts = null)
public static VpcIpamResourceDiscoveryAssociation get(String name, Output<String> id, VpcIpamResourceDiscoveryAssociationState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2:VpcIpamResourceDiscoveryAssociation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
IpamArn string
The Amazon Resource Name (ARN) of the IPAM.
IpamId string
The ID of the IPAM to associate.
IpamRegion string
The home region of the IPAM.
IpamResourceDiscoveryId string
The ID of the Resource Discovery to associate.
IsDefault bool
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
OwnerId string
The account ID for the account that manages the Resource Discovery
State string
The lifecycle state of the association when you associate or disassociate a resource discovery.
Tags Dictionary<string, string>
A map of tags to add to the IPAM resource discovery association resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
IpamArn string
The Amazon Resource Name (ARN) of the IPAM.
IpamId string
The ID of the IPAM to associate.
IpamRegion string
The home region of the IPAM.
IpamResourceDiscoveryId string
The ID of the Resource Discovery to associate.
IsDefault bool
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
OwnerId string
The account ID for the account that manages the Resource Discovery
State string
The lifecycle state of the association when you associate or disassociate a resource discovery.
Tags map[string]string
A map of tags to add to the IPAM resource discovery association resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
ipamArn String
The Amazon Resource Name (ARN) of the IPAM.
ipamId String
The ID of the IPAM to associate.
ipamRegion String
The home region of the IPAM.
ipamResourceDiscoveryId String
The ID of the Resource Discovery to associate.
isDefault Boolean
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
ownerId String
The account ID for the account that manages the Resource Discovery
state String
The lifecycle state of the association when you associate or disassociate a resource discovery.
tags Map<String,String>
A map of tags to add to the IPAM resource discovery association resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
ipamArn string
The Amazon Resource Name (ARN) of the IPAM.
ipamId string
The ID of the IPAM to associate.
ipamRegion string
The home region of the IPAM.
ipamResourceDiscoveryId string
The ID of the Resource Discovery to associate.
isDefault boolean
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
ownerId string
The account ID for the account that manages the Resource Discovery
state string
The lifecycle state of the association when you associate or disassociate a resource discovery.
tags {[key: string]: string}
A map of tags to add to the IPAM resource discovery association resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
ipam_arn str
The Amazon Resource Name (ARN) of the IPAM.
ipam_id str
The ID of the IPAM to associate.
ipam_region str
The home region of the IPAM.
ipam_resource_discovery_id str
The ID of the Resource Discovery to associate.
is_default bool
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
owner_id str
The account ID for the account that manages the Resource Discovery
state str
The lifecycle state of the association when you associate or disassociate a resource discovery.
tags Mapping[str, str]
A map of tags to add to the IPAM resource discovery association resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of IPAM Resource Discovery Association.
ipamArn String
The Amazon Resource Name (ARN) of the IPAM.
ipamId String
The ID of the IPAM to associate.
ipamRegion String
The home region of the IPAM.
ipamResourceDiscoveryId String
The ID of the Resource Discovery to associate.
isDefault Boolean
A boolean to identify if the Resource Discovery is the accounts default resource discovery.
ownerId String
The account ID for the account that manages the Resource Discovery
state String
The lifecycle state of the association when you associate or disassociate a resource discovery.
tags Map<String>
A map of tags to add to the IPAM resource discovery association resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import IPAMs using the IPAM resource discovery association id. For example:

$ pulumi import aws:ec2/vpcIpamResourceDiscoveryAssociation:VpcIpamResourceDiscoveryAssociation example ipam-res-disco-assoc-0178368ad2146a492
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws