@huaweicloudos/pulumi/vpc/subnet.d.ts

A Pulumi package for creating and managing Huaweicloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a VPC subnet resource within HuaweiCloud.
 *
 * ## Import
 *
 * Subnets can be imported using the subnet `Network ID`, e.g. bash
 *
 * ```sh
 *  $ pulumi import huaweicloud:Vpc/subnet:Subnet subnet 4779ab1c-7c1a-44b1-a02e-93dfc361b32d
 * ```
 */
export declare class Subnet extends pulumi.CustomResource {
    /**
     * Get an existing Subnet resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetState, opts?: pulumi.CustomResourceOptions): Subnet;
    /**
     * Returns true if the given object is an instance of Subnet.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Subnet;
    /**
     * Specifies the availability zone (AZ) to which the subnet belongs.
     * The value must be an existing AZ in the system. Changing this creates a new subnet.
     */
    readonly availabilityZone: pulumi.Output<string>;
    /**
     * Specifies the network segment on which the subnet resides. The value must be in
     * CIDR format and within the CIDR block of the VPC. The subnet mask cannot be greater than 28. Changing this creates a
     * new subnet.
     */
    readonly cidr: pulumi.Output<string>;
    /**
     * Specifies supplementary information about the subnet. The value is a string of
     * no more than 255 characters and cannot contain angle brackets (< or >).
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Specifies whether the DHCP function is enabled for the subnet. Defaults to true.
     */
    readonly dhcpEnable: pulumi.Output<boolean | undefined>;
    /**
     * Specifies the DHCP lease expiration time. The value can be -1, which indicates
     * unlimited lease time, or Number+h. the number ranges from 1 to 30,000. For example, the value can be 5h. The default
     * value is 24h.
     */
    readonly dhcpLeaseTime: pulumi.Output<string>;
    /**
     * Specifies the DNS server address list of a subnet. This field is required if you need to
     * use more than two DNS servers. This parameter value is the superset of both DNS server address 1 and DNS server
     * address 2.
     */
    readonly dnsLists: pulumi.Output<string[]>;
    /**
     * Specifies the gateway of the subnet. The value must be a valid IP address
     * in the subnet segment. Changing this creates a new subnet.
     */
    readonly gatewayIp: pulumi.Output<string>;
    /**
     * The ID of the IPv4 subnet (Native OpenStack API).
     */
    readonly ipv4SubnetId: pulumi.Output<string>;
    /**
     * The IPv6 subnet CIDR block.
     */
    readonly ipv6Cidr: pulumi.Output<string>;
    /**
     * Specifies whether the IPv6 function is enabled for the subnet. Defaults to false.
     */
    readonly ipv6Enable: pulumi.Output<boolean | undefined>;
    /**
     * The IPv6 subnet gateway.
     */
    readonly ipv6Gateway: pulumi.Output<string>;
    /**
     * The ID of the IPv6 subnet (Native OpenStack API).
     */
    readonly ipv6SubnetId: pulumi.Output<string>;
    /**
     * Specifies the subnet name. The value is a string of 1 to 64 characters that can contain
     * letters, digits, underscores (_), and hyphens (-).
     */
    readonly name: pulumi.Output<string>;
    /**
     * Specifies the NTP server address. Currently only IPv4 addresses are supported.
     * A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be
     * separated using commas(,). Removing this parameter indicates that no NTP server is configured.
     */
    readonly ntpServerAddress: pulumi.Output<string | undefined>;
    /**
     * Specifies the IP address of DNS server 1 on the subnet. The value must be a valid
     * IP address.
     */
    readonly primaryDns: pulumi.Output<string>;
    /**
     * Specifies the region in which to create the vpc subnet. If omitted, the
     * provider-level region will be used. Changing this creates a new subnet.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Specifies the IP address of DNS server 2 on the subnet. The value must be a valid
     * IP address.
     */
    readonly secondaryDns: pulumi.Output<string>;
    /**
     * schema: Deprecated
     */
    readonly subnetId: pulumi.Output<string>;
    /**
     * The key/value pairs to associate with the subnet.
     */
    readonly tags: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Specifies the ID of the VPC to which the subnet belongs. Changing this creates
     * a new subnet.
     */
    readonly vpcId: pulumi.Output<string>;
    /**
     * Create a Subnet resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: SubnetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Subnet resources.
 */
export interface SubnetState {
    /**
     * Specifies the availability zone (AZ) to which the subnet belongs.
     * The value must be an existing AZ in the system. Changing this creates a new subnet.
     */
    availabilityZone?: pulumi.Input<string>;
    /**
     * Specifies the network segment on which the subnet resides. The value must be in
     * CIDR format and within the CIDR block of the VPC. The subnet mask cannot be greater than 28. Changing this creates a
     * new subnet.
     */
    cidr?: pulumi.Input<string>;
    /**
     * Specifies supplementary information about the subnet. The value is a string of
     * no more than 255 characters and cannot contain angle brackets (< or >).
     */
    description?: pulumi.Input<string>;
    /**
     * Specifies whether the DHCP function is enabled for the subnet. Defaults to true.
     */
    dhcpEnable?: pulumi.Input<boolean>;
    /**
     * Specifies the DHCP lease expiration time. The value can be -1, which indicates
     * unlimited lease time, or Number+h. the number ranges from 1 to 30,000. For example, the value can be 5h. The default
     * value is 24h.
     */
    dhcpLeaseTime?: pulumi.Input<string>;
    /**
     * Specifies the DNS server address list of a subnet. This field is required if you need to
     * use more than two DNS servers. This parameter value is the superset of both DNS server address 1 and DNS server
     * address 2.
     */
    dnsLists?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Specifies the gateway of the subnet. The value must be a valid IP address
     * in the subnet segment. Changing this creates a new subnet.
     */
    gatewayIp?: pulumi.Input<string>;
    /**
     * The ID of the IPv4 subnet (Native OpenStack API).
     */
    ipv4SubnetId?: pulumi.Input<string>;
    /**
     * The IPv6 subnet CIDR block.
     */
    ipv6Cidr?: pulumi.Input<string>;
    /**
     * Specifies whether the IPv6 function is enabled for the subnet. Defaults to false.
     */
    ipv6Enable?: pulumi.Input<boolean>;
    /**
     * The IPv6 subnet gateway.
     */
    ipv6Gateway?: pulumi.Input<string>;
    /**
     * The ID of the IPv6 subnet (Native OpenStack API).
     */
    ipv6SubnetId?: pulumi.Input<string>;
    /**
     * Specifies the subnet name. The value is a string of 1 to 64 characters that can contain
     * letters, digits, underscores (_), and hyphens (-).
     */
    name?: pulumi.Input<string>;
    /**
     * Specifies the NTP server address. Currently only IPv4 addresses are supported.
     * A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be
     * separated using commas(,). Removing this parameter indicates that no NTP server is configured.
     */
    ntpServerAddress?: pulumi.Input<string>;
    /**
     * Specifies the IP address of DNS server 1 on the subnet. The value must be a valid
     * IP address.
     */
    primaryDns?: pulumi.Input<string>;
    /**
     * Specifies the region in which to create the vpc subnet. If omitted, the
     * provider-level region will be used. Changing this creates a new subnet.
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the IP address of DNS server 2 on the subnet. The value must be a valid
     * IP address.
     */
    secondaryDns?: pulumi.Input<string>;
    /**
     * schema: Deprecated
     */
    subnetId?: pulumi.Input<string>;
    /**
     * The key/value pairs to associate with the subnet.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Specifies the ID of the VPC to which the subnet belongs. Changing this creates
     * a new subnet.
     */
    vpcId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Subnet resource.
 */
export interface SubnetArgs {
    /**
     * Specifies the availability zone (AZ) to which the subnet belongs.
     * The value must be an existing AZ in the system. Changing this creates a new subnet.
     */
    availabilityZone?: pulumi.Input<string>;
    /**
     * Specifies the network segment on which the subnet resides. The value must be in
     * CIDR format and within the CIDR block of the VPC. The subnet mask cannot be greater than 28. Changing this creates a
     * new subnet.
     */
    cidr: pulumi.Input<string>;
    /**
     * Specifies supplementary information about the subnet. The value is a string of
     * no more than 255 characters and cannot contain angle brackets (< or >).
     */
    description?: pulumi.Input<string>;
    /**
     * Specifies whether the DHCP function is enabled for the subnet. Defaults to true.
     */
    dhcpEnable?: pulumi.Input<boolean>;
    /**
     * Specifies the DHCP lease expiration time. The value can be -1, which indicates
     * unlimited lease time, or Number+h. the number ranges from 1 to 30,000. For example, the value can be 5h. The default
     * value is 24h.
     */
    dhcpLeaseTime?: pulumi.Input<string>;
    /**
     * Specifies the DNS server address list of a subnet. This field is required if you need to
     * use more than two DNS servers. This parameter value is the superset of both DNS server address 1 and DNS server
     * address 2.
     */
    dnsLists?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Specifies the gateway of the subnet. The value must be a valid IP address
     * in the subnet segment. Changing this creates a new subnet.
     */
    gatewayIp: pulumi.Input<string>;
    /**
     * Specifies whether the IPv6 function is enabled for the subnet. Defaults to false.
     */
    ipv6Enable?: pulumi.Input<boolean>;
    /**
     * Specifies the subnet name. The value is a string of 1 to 64 characters that can contain
     * letters, digits, underscores (_), and hyphens (-).
     */
    name?: pulumi.Input<string>;
    /**
     * Specifies the NTP server address. Currently only IPv4 addresses are supported.
     * A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be
     * separated using commas(,). Removing this parameter indicates that no NTP server is configured.
     */
    ntpServerAddress?: pulumi.Input<string>;
    /**
     * Specifies the IP address of DNS server 1 on the subnet. The value must be a valid
     * IP address.
     */
    primaryDns?: pulumi.Input<string>;
    /**
     * Specifies the region in which to create the vpc subnet. If omitted, the
     * provider-level region will be used. Changing this creates a new subnet.
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the IP address of DNS server 2 on the subnet. The value must be a valid
     * IP address.
     */
    secondaryDns?: pulumi.Input<string>;
    /**
     * The key/value pairs to associate with the subnet.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Specifies the ID of the VPC to which the subnet belongs. Changing this creates
     * a new subnet.
     */
    vpcId: pulumi.Input<string>;
}