Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. IpamIpamScope
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.vpc.IpamIpamScope

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Vpc Ipam Ipam Scope resource.

    IP Address Management Scope.

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

    NOTE: Available since v1.234.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 defaultIpam = new alicloud.vpc.IpamIpam("defaultIpam", {
    operatingRegionLists: ["cn-hangzhou"],
    ipamName: name,
});
const _default = new alicloud.vpc.IpamIpamScope("default", {
    ipamScopeName: name,
    ipamId: defaultIpam.id,
    ipamScopeDescription: "This is a ipam scope.",
    ipamScopeType: "private",
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default_ipam = alicloud.vpc.IpamIpam("defaultIpam",
    operating_region_lists=["cn-hangzhou"],
    ipam_name=name)
default = alicloud.vpc.IpamIpamScope("default",
    ipam_scope_name=name,
    ipam_id=default_ipam.id,
    ipam_scope_description="This is a ipam scope.",
    ipam_scope_type="private")

    package main

import (
	"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
		}
		defaultIpam, err := vpc.NewIpamIpam(ctx, "defaultIpam", &vpc.IpamIpamArgs{
			OperatingRegionLists: pulumi.StringArray{
				pulumi.String("cn-hangzhou"),
			},
			IpamName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = vpc.NewIpamIpamScope(ctx, "default", &vpc.IpamIpamScopeArgs{
			IpamScopeName:        pulumi.String(name),
			IpamId:               defaultIpam.ID(),
			IpamScopeDescription: pulumi.String("This is a ipam scope."),
			IpamScopeType:        pulumi.String("private"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 defaultIpam = new AliCloud.Vpc.IpamIpam("defaultIpam", new()
    {
        OperatingRegionLists = new[]
        {
            "cn-hangzhou",
        },
        IpamName = name,
    });

    var @default = new AliCloud.Vpc.IpamIpamScope("default", new()
    {
        IpamScopeName = name,
        IpamId = defaultIpam.Id,
        IpamScopeDescription = "This is a ipam scope.",
        IpamScopeType = "private",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.IpamIpam;
import com.pulumi.alicloud.vpc.IpamIpamArgs;
import com.pulumi.alicloud.vpc.IpamIpamScope;
import com.pulumi.alicloud.vpc.IpamIpamScopeArgs;
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");
        var defaultIpam = new IpamIpam("defaultIpam", IpamIpamArgs.builder()
            .operatingRegionLists("cn-hangzhou")
            .ipamName(name)
            .build());

        var default_ = new IpamIpamScope("default", IpamIpamScopeArgs.builder()
            .ipamScopeName(name)
            .ipamId(defaultIpam.id())
            .ipamScopeDescription("This is a ipam scope.")
            .ipamScopeType("private")
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
resources:
  defaultIpam:
    type: alicloud:vpc:IpamIpam
    properties:
      operatingRegionLists:
        - cn-hangzhou
      ipamName: ${name}
  default:
    type: alicloud:vpc:IpamIpamScope
    properties:
      ipamScopeName: ${name}
      ipamId: ${defaultIpam.id}
      ipamScopeDescription: This is a ipam scope.
      ipamScopeType: private

    Create IpamIpamScope Resource

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

    Constructor syntax

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

@overload
def IpamIpamScope(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  ipam_id: Optional[str] = None,
                  ipam_scope_description: Optional[str] = None,
                  ipam_scope_name: Optional[str] = None,
                  ipam_scope_type: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewIpamIpamScope(ctx *Context, name string, args IpamIpamScopeArgs, opts ...ResourceOption) (*IpamIpamScope, error)
    public IpamIpamScope(string name, IpamIpamScopeArgs args, CustomResourceOptions? opts = null)
    public IpamIpamScope(String name, IpamIpamScopeArgs args)
public IpamIpamScope(String name, IpamIpamScopeArgs args, CustomResourceOptions options)

    type: alicloud:vpc:IpamIpamScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IpamIpamScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IpamIpamScopeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IpamIpamScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpamIpamScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpamIpamScopeArgs
    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 ipamIpamScopeResource = new AliCloud.Vpc.IpamIpamScope("ipamIpamScopeResource", new()
{
    IpamId = "string",
    IpamScopeDescription = "string",
    IpamScopeName = "string",
    IpamScopeType = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := vpc.NewIpamIpamScope(ctx, "ipamIpamScopeResource", &vpc.IpamIpamScopeArgs{
	IpamId:               pulumi.String("string"),
	IpamScopeDescription: pulumi.String("string"),
	IpamScopeName:        pulumi.String("string"),
	IpamScopeType:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var ipamIpamScopeResource = new IpamIpamScope("ipamIpamScopeResource", IpamIpamScopeArgs.builder()
    .ipamId("string")
    .ipamScopeDescription("string")
    .ipamScopeName("string")
    .ipamScopeType("string")
    .tags(Map.of("string", "string"))
    .build());

    ipam_ipam_scope_resource = alicloud.vpc.IpamIpamScope("ipamIpamScopeResource",
    ipam_id="string",
    ipam_scope_description="string",
    ipam_scope_name="string",
    ipam_scope_type="string",
    tags={
        "string": "string",
    })

    const ipamIpamScopeResource = new alicloud.vpc.IpamIpamScope("ipamIpamScopeResource", {
    ipamId: "string",
    ipamScopeDescription: "string",
    ipamScopeName: "string",
    ipamScopeType: "string",
    tags: {
        string: "string",
    },
});

    type: alicloud:vpc:IpamIpamScope
properties:
    ipamId: string
    ipamScopeDescription: string
    ipamScopeName: string
    ipamScopeType: string
    tags:
        string: string

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

    IpamId string
    The id of the Ipam instance.
    IpamScopeDescription string

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    IpamScopeName string
    The name of the resource.
    IpamScopeType string

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    Tags Dictionary<string, string>
    The tag of the resource.
    IpamId string
    The id of the Ipam instance.
    IpamScopeDescription string

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    IpamScopeName string
    The name of the resource.
    IpamScopeType string

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    Tags map[string]string
    The tag of the resource.
    ipamId String
    The id of the Ipam instance.
    ipamScopeDescription String

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipamScopeName String
    The name of the resource.
    ipamScopeType String

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    tags Map<String,String>
    The tag of the resource.
    ipamId string
    The id of the Ipam instance.
    ipamScopeDescription string

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipamScopeName string
    The name of the resource.
    ipamScopeType string

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    tags {[key: string]: string}
    The tag of the resource.
    ipam_id str
    The id of the Ipam instance.
    ipam_scope_description str

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipam_scope_name str
    The name of the resource.
    ipam_scope_type str

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    tags Mapping[str, str]
    The tag of the resource.
    ipamId String
    The id of the Ipam instance.
    ipamScopeDescription String

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipamScopeName String
    The name of the resource.
    ipamScopeType String

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    tags Map<String>
    The tag of the resource.

    Outputs

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

    CreateTime string
    The creation time of the resource.
    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.
    CreateTime string
    The creation time of the resource.
    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.
    createTime String
    The creation time of the resource.
    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.
    createTime string
    The creation time of the resource.
    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.
    create_time str
    The creation time of the resource.
    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.
    createTime String
    The creation time of the resource.
    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.

    Look up Existing IpamIpamScope Resource

    Get an existing IpamIpamScope 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?: IpamIpamScopeState, opts?: CustomResourceOptions): IpamIpamScope
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        ipam_id: Optional[str] = None,
        ipam_scope_description: Optional[str] = None,
        ipam_scope_name: Optional[str] = None,
        ipam_scope_type: Optional[str] = None,
        region_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> IpamIpamScope
    func GetIpamIpamScope(ctx *Context, name string, id IDInput, state *IpamIpamScopeState, opts ...ResourceOption) (*IpamIpamScope, error)
    public static IpamIpamScope Get(string name, Input<string> id, IpamIpamScopeState? state, CustomResourceOptions? opts = null)
    public static IpamIpamScope get(String name, Output<String> id, IpamIpamScopeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 creation time of the resource.
    IpamId string
    The id of the Ipam instance.
    IpamScopeDescription string

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    IpamScopeName string
    The name of the resource.
    IpamScopeType string

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    RegionId string
    The region ID of the resource.
    Status string
    The status of the resource.
    Tags Dictionary<string, string>
    The tag of the resource.
    CreateTime string
    The creation time of the resource.
    IpamId string
    The id of the Ipam instance.
    IpamScopeDescription string

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    IpamScopeName string
    The name of the resource.
    IpamScopeType string

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    RegionId string
    The region ID of the resource.
    Status string
    The status of the resource.
    Tags map[string]string
    The tag of the resource.
    createTime String
    The creation time of the resource.
    ipamId String
    The id of the Ipam instance.
    ipamScopeDescription String

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipamScopeName String
    The name of the resource.
    ipamScopeType String

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    regionId String
    The region ID of the resource.
    status String
    The status of the resource.
    tags Map<String,String>
    The tag of the resource.
    createTime string
    The creation time of the resource.
    ipamId string
    The id of the Ipam instance.
    ipamScopeDescription string

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipamScopeName string
    The name of the resource.
    ipamScopeType string

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    regionId string
    The region ID of the resource.
    status string
    The status of the resource.
    tags {[key: string]: string}
    The tag of the resource.
    create_time str
    The creation time of the resource.
    ipam_id str
    The id of the Ipam instance.
    ipam_scope_description str

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipam_scope_name str
    The name of the resource.
    ipam_scope_type str

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    region_id str
    The region ID of the resource.
    status str
    The status of the resource.
    tags Mapping[str, str]
    The tag of the resource.
    createTime String
    The creation time of the resource.
    ipamId String
    The id of the Ipam instance.
    ipamScopeDescription String

    The description of the IPAM's scope of action.

    It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

    ipamScopeName String
    The name of the resource.
    ipamScopeType String

    IPAM scope of action type: private.

    NOTE: Currently, only the role scope of the private network is supported.

    regionId String
    The region ID of the resource.
    status String
    The status of the resource.
    tags Map<String>
    The tag of the resource.

    Import

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

    $ pulumi import alicloud:vpc/ipamIpamScope:IpamIpamScope example <id>

    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.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud