1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. IpamIpamResourceDiscovery
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.vpc.IpamIpamResourceDiscovery

Explore with Pulumi AI

Provides a Vpc Ipam Ipam Resource Discovery resource.

IP Address Management Resource Discovery.

For information about Vpc Ipam Ipam Resource Discovery and how to use it, see What is Ipam Resource Discovery.

NOTE: Available since v1.243.0.

Example Usage

Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultIpamIpamResourceDiscovery = new alicloud.vpc.IpamIpamResourceDiscovery("default", {
    operatingRegionLists: ["cn-hangzhou"],
    ipamResourceDiscoveryDescription: "This is a custom IPAM resource discovery.",
    ipamResourceDiscoveryName: "example_resource_discovery",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.resourcemanager.get_resource_groups()
default_ipam_ipam_resource_discovery = alicloud.vpc.IpamIpamResourceDiscovery("default",
    operating_region_lists=["cn-hangzhou"],
    ipam_resource_discovery_description="This is a custom IPAM resource discovery.",
    ipam_resource_discovery_name="example_resource_discovery")
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = vpc.NewIpamIpamResourceDiscovery(ctx, "default", &vpc.IpamIpamResourceDiscoveryArgs{
			OperatingRegionLists: pulumi.StringArray{
				pulumi.String("cn-hangzhou"),
			},
			IpamResourceDiscoveryDescription: pulumi.String("This is a custom IPAM resource discovery."),
			IpamResourceDiscoveryName:        pulumi.String("example_resource_discovery"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultIpamIpamResourceDiscovery = new AliCloud.Vpc.IpamIpamResourceDiscovery("default", new()
    {
        OperatingRegionLists = new[]
        {
            "cn-hangzhou",
        },
        IpamResourceDiscoveryDescription = "This is a custom IPAM resource discovery.",
        IpamResourceDiscoveryName = "example_resource_discovery",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.vpc.IpamIpamResourceDiscovery;
import com.pulumi.alicloud.vpc.IpamIpamResourceDiscoveryArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var default = ResourcemanagerFunctions.getResourceGroups();

        var defaultIpamIpamResourceDiscovery = new IpamIpamResourceDiscovery("defaultIpamIpamResourceDiscovery", IpamIpamResourceDiscoveryArgs.builder()
            .operatingRegionLists("cn-hangzhou")
            .ipamResourceDiscoveryDescription("This is a custom IPAM resource discovery.")
            .ipamResourceDiscoveryName("example_resource_discovery")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform-example
resources:
  defaultIpamIpamResourceDiscovery:
    type: alicloud:vpc:IpamIpamResourceDiscovery
    name: default
    properties:
      operatingRegionLists:
        - cn-hangzhou
      ipamResourceDiscoveryDescription: This is a custom IPAM resource discovery.
      ipamResourceDiscoveryName: example_resource_discovery
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments: {}
Copy

Create IpamIpamResourceDiscovery Resource

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

Constructor syntax

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

@overload
def IpamIpamResourceDiscovery(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              operating_region_lists: Optional[Sequence[str]] = None,
                              ipam_resource_discovery_description: Optional[str] = None,
                              ipam_resource_discovery_name: Optional[str] = None,
                              resource_group_id: Optional[str] = None,
                              tags: Optional[Mapping[str, str]] = None)
func NewIpamIpamResourceDiscovery(ctx *Context, name string, args IpamIpamResourceDiscoveryArgs, opts ...ResourceOption) (*IpamIpamResourceDiscovery, error)
public IpamIpamResourceDiscovery(string name, IpamIpamResourceDiscoveryArgs args, CustomResourceOptions? opts = null)
public IpamIpamResourceDiscovery(String name, IpamIpamResourceDiscoveryArgs args)
public IpamIpamResourceDiscovery(String name, IpamIpamResourceDiscoveryArgs args, CustomResourceOptions options)
type: alicloud:vpc:IpamIpamResourceDiscovery
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. IpamIpamResourceDiscoveryArgs
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. IpamIpamResourceDiscoveryArgs
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. IpamIpamResourceDiscoveryArgs
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. IpamIpamResourceDiscoveryArgs
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. IpamIpamResourceDiscoveryArgs
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 ipamIpamResourceDiscoveryResource = new AliCloud.Vpc.IpamIpamResourceDiscovery("ipamIpamResourceDiscoveryResource", new()
{
    OperatingRegionLists = new[]
    {
        "string",
    },
    IpamResourceDiscoveryDescription = "string",
    IpamResourceDiscoveryName = "string",
    ResourceGroupId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := vpc.NewIpamIpamResourceDiscovery(ctx, "ipamIpamResourceDiscoveryResource", &vpc.IpamIpamResourceDiscoveryArgs{
	OperatingRegionLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpamResourceDiscoveryDescription: pulumi.String("string"),
	IpamResourceDiscoveryName:        pulumi.String("string"),
	ResourceGroupId:                  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var ipamIpamResourceDiscoveryResource = new IpamIpamResourceDiscovery("ipamIpamResourceDiscoveryResource", IpamIpamResourceDiscoveryArgs.builder()
    .operatingRegionLists("string")
    .ipamResourceDiscoveryDescription("string")
    .ipamResourceDiscoveryName("string")
    .resourceGroupId("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
ipam_ipam_resource_discovery_resource = alicloud.vpc.IpamIpamResourceDiscovery("ipamIpamResourceDiscoveryResource",
    operating_region_lists=["string"],
    ipam_resource_discovery_description="string",
    ipam_resource_discovery_name="string",
    resource_group_id="string",
    tags={
        "string": "string",
    })
Copy
const ipamIpamResourceDiscoveryResource = new alicloud.vpc.IpamIpamResourceDiscovery("ipamIpamResourceDiscoveryResource", {
    operatingRegionLists: ["string"],
    ipamResourceDiscoveryDescription: "string",
    ipamResourceDiscoveryName: "string",
    resourceGroupId: "string",
    tags: {
        string: "string",
    },
});
Copy
type: alicloud:vpc:IpamIpamResourceDiscovery
properties:
    ipamResourceDiscoveryDescription: string
    ipamResourceDiscoveryName: string
    operatingRegionLists:
        - string
    resourceGroupId: string
    tags:
        string: string
Copy

IpamIpamResourceDiscovery 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 IpamIpamResourceDiscovery resource accepts the following input properties:

OperatingRegionLists This property is required. List<string>
The list of operating regions for resource discovery.
IpamResourceDiscoveryDescription string
The description of resource discovery.
IpamResourceDiscoveryName string
The name of the resource
ResourceGroupId string
The ID of the resource group
Tags Dictionary<string, string>
Label list information.
OperatingRegionLists This property is required. []string
The list of operating regions for resource discovery.
IpamResourceDiscoveryDescription string
The description of resource discovery.
IpamResourceDiscoveryName string
The name of the resource
ResourceGroupId string
The ID of the resource group
Tags map[string]string
Label list information.
operatingRegionLists This property is required. List<String>
The list of operating regions for resource discovery.
ipamResourceDiscoveryDescription String
The description of resource discovery.
ipamResourceDiscoveryName String
The name of the resource
resourceGroupId String
The ID of the resource group
tags Map<String,String>
Label list information.
operatingRegionLists This property is required. string[]
The list of operating regions for resource discovery.
ipamResourceDiscoveryDescription string
The description of resource discovery.
ipamResourceDiscoveryName string
The name of the resource
resourceGroupId string
The ID of the resource group
tags {[key: string]: string}
Label list information.
operating_region_lists This property is required. Sequence[str]
The list of operating regions for resource discovery.
ipam_resource_discovery_description str
The description of resource discovery.
ipam_resource_discovery_name str
The name of the resource
resource_group_id str
The ID of the resource group
tags Mapping[str, str]
Label list information.
operatingRegionLists This property is required. List<String>
The list of operating regions for resource discovery.
ipamResourceDiscoveryDescription String
The description of resource discovery.
ipamResourceDiscoveryName String
The name of the resource
resourceGroupId String
The ID of the resource group
tags Map<String>
Label list information.

Outputs

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

CreateTime string
The time when the resource discovery was created.
Id string
The provider-assigned unique ID for this managed resource.
RegionId string
The region ID of the resource
Status string
The status of the resource discovery instance. Value:
CreateTime string
The time when the resource discovery was created.
Id string
The provider-assigned unique ID for this managed resource.
RegionId string
The region ID of the resource
Status string
The status of the resource discovery instance. Value:
createTime String
The time when the resource discovery was created.
id String
The provider-assigned unique ID for this managed resource.
regionId String
The region ID of the resource
status String
The status of the resource discovery instance. Value:
createTime string
The time when the resource discovery was created.
id string
The provider-assigned unique ID for this managed resource.
regionId string
The region ID of the resource
status string
The status of the resource discovery instance. Value:
create_time str
The time when the resource discovery was created.
id str
The provider-assigned unique ID for this managed resource.
region_id str
The region ID of the resource
status str
The status of the resource discovery instance. Value:
createTime String
The time when the resource discovery was created.
id String
The provider-assigned unique ID for this managed resource.
regionId String
The region ID of the resource
status String
The status of the resource discovery instance. Value:

Look up Existing IpamIpamResourceDiscovery Resource

Get an existing IpamIpamResourceDiscovery 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?: IpamIpamResourceDiscoveryState, opts?: CustomResourceOptions): IpamIpamResourceDiscovery
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        ipam_resource_discovery_description: Optional[str] = None,
        ipam_resource_discovery_name: Optional[str] = None,
        operating_region_lists: Optional[Sequence[str]] = None,
        region_id: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> IpamIpamResourceDiscovery
func GetIpamIpamResourceDiscovery(ctx *Context, name string, id IDInput, state *IpamIpamResourceDiscoveryState, opts ...ResourceOption) (*IpamIpamResourceDiscovery, error)
public static IpamIpamResourceDiscovery Get(string name, Input<string> id, IpamIpamResourceDiscoveryState? state, CustomResourceOptions? opts = null)
public static IpamIpamResourceDiscovery get(String name, Output<String> id, IpamIpamResourceDiscoveryState state, CustomResourceOptions options)
resources:  _:    type: alicloud:vpc:IpamIpamResourceDiscovery    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:
CreateTime string
The time when the resource discovery was created.
IpamResourceDiscoveryDescription string
The description of resource discovery.
IpamResourceDiscoveryName string
The name of the resource
OperatingRegionLists List<string>
The list of operating regions for resource discovery.
RegionId string
The region ID of the resource
ResourceGroupId string
The ID of the resource group
Status string
The status of the resource discovery instance. Value:
Tags Dictionary<string, string>
Label list information.
CreateTime string
The time when the resource discovery was created.
IpamResourceDiscoveryDescription string
The description of resource discovery.
IpamResourceDiscoveryName string
The name of the resource
OperatingRegionLists []string
The list of operating regions for resource discovery.
RegionId string
The region ID of the resource
ResourceGroupId string
The ID of the resource group
Status string
The status of the resource discovery instance. Value:
Tags map[string]string
Label list information.
createTime String
The time when the resource discovery was created.
ipamResourceDiscoveryDescription String
The description of resource discovery.
ipamResourceDiscoveryName String
The name of the resource
operatingRegionLists List<String>
The list of operating regions for resource discovery.
regionId String
The region ID of the resource
resourceGroupId String
The ID of the resource group
status String
The status of the resource discovery instance. Value:
tags Map<String,String>
Label list information.
createTime string
The time when the resource discovery was created.
ipamResourceDiscoveryDescription string
The description of resource discovery.
ipamResourceDiscoveryName string
The name of the resource
operatingRegionLists string[]
The list of operating regions for resource discovery.
regionId string
The region ID of the resource
resourceGroupId string
The ID of the resource group
status string
The status of the resource discovery instance. Value:
tags {[key: string]: string}
Label list information.
create_time str
The time when the resource discovery was created.
ipam_resource_discovery_description str
The description of resource discovery.
ipam_resource_discovery_name str
The name of the resource
operating_region_lists Sequence[str]
The list of operating regions for resource discovery.
region_id str
The region ID of the resource
resource_group_id str
The ID of the resource group
status str
The status of the resource discovery instance. Value:
tags Mapping[str, str]
Label list information.
createTime String
The time when the resource discovery was created.
ipamResourceDiscoveryDescription String
The description of resource discovery.
ipamResourceDiscoveryName String
The name of the resource
operatingRegionLists List<String>
The list of operating regions for resource discovery.
regionId String
The region ID of the resource
resourceGroupId String
The ID of the resource group
status String
The status of the resource discovery instance. Value:
tags Map<String>
Label list information.

Import

Vpc Ipam Ipam Resource Discovery can be imported using the id, e.g.

$ pulumi import alicloud:vpc/ipamIpamResourceDiscovery:IpamIpamResourceDiscovery example <id>
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.