@pulumiverse/scaleway/network/getPrivateNetwork.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets information about a Private Network.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by name
 * const myName = scaleway.network.getPrivateNetwork({
 *     name: "foobar",
 * });
 * // Get info by name and VPC ID
 * const myNameAndVpcId = scaleway.network.getPrivateNetwork({
 *     name: "foobar",
 *     vpcId: "11111111-1111-1111-1111-111111111111",
 * });
 * // Get info by name in a specific region
 * const myNameAndRegion = scaleway.network.getPrivateNetwork({
 *     name: "foobar",
 *     region: "nl-ams",
 * });
 * // Get info by Private Network ID
 * const myId = scaleway.network.getPrivateNetwork({
 *     privateNetworkId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
export declare function getPrivateNetwork(args?: GetPrivateNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetPrivateNetworkResult>;
/**
 * A collection of arguments for invoking getPrivateNetwork.
 */
export interface GetPrivateNetworkArgs {
    /**
     * Name of the Private Network. Cannot be used with `privateNetworkId`.
     */
    name?: string;
    /**
     * ID of the Private Network. Cannot be used with `name` or `vpcId`.
     */
    privateNetworkId?: string;
    /**
     * The ID of the Project the Private Network is associated with.
     */
    projectId?: string;
    /**
     * `region`) The region in which the Private Network exists.
     */
    region?: string;
    /**
     * ID of the VPC the Private Network is in. Cannot be used with `privateNetworkId`.
     */
    vpcId?: string;
}
/**
 * A collection of values returned by getPrivateNetwork.
 */
export interface GetPrivateNetworkResult {
    readonly createdAt: string;
    readonly enableDefaultRoutePropagation: boolean;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The IPv4 subnet associated with the Private Network.
     */
    readonly ipv4Subnets: outputs.network.GetPrivateNetworkIpv4Subnet[];
    /**
     * The IPv6 subnets associated with the Private Network.
     */
    readonly ipv6Subnets: outputs.network.GetPrivateNetworkIpv6Subnet[];
    readonly isRegional: boolean;
    readonly name?: string;
    readonly organizationId: string;
    readonly privateNetworkId?: string;
    readonly projectId?: string;
    readonly region?: string;
    readonly tags: string[];
    readonly updatedAt: string;
    readonly vpcId?: string;
    readonly zone: string;
}
/**
 * Gets information about a Private Network.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by name
 * const myName = scaleway.network.getPrivateNetwork({
 *     name: "foobar",
 * });
 * // Get info by name and VPC ID
 * const myNameAndVpcId = scaleway.network.getPrivateNetwork({
 *     name: "foobar",
 *     vpcId: "11111111-1111-1111-1111-111111111111",
 * });
 * // Get info by name in a specific region
 * const myNameAndRegion = scaleway.network.getPrivateNetwork({
 *     name: "foobar",
 *     region: "nl-ams",
 * });
 * // Get info by Private Network ID
 * const myId = scaleway.network.getPrivateNetwork({
 *     privateNetworkId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
export declare function getPrivateNetworkOutput(args?: GetPrivateNetworkOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPrivateNetworkResult>;
/**
 * A collection of arguments for invoking getPrivateNetwork.
 */
export interface GetPrivateNetworkOutputArgs {
    /**
     * Name of the Private Network. Cannot be used with `privateNetworkId`.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * ID of the Private Network. Cannot be used with `name` or `vpcId`.
     */
    privateNetworkId?: pulumi.Input<string | undefined>;
    /**
     * The ID of the Project the Private Network is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the Private Network exists.
     */
    region?: pulumi.Input<string | undefined>;
    /**
     * ID of the VPC the Private Network is in. Cannot be used with `privateNetworkId`.
     */
    vpcId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getPrivateNetwork.d.ts.map