Files
pulumi-incus/sdk/nodejs/network.ts
2025-04-24 21:09:04 -04:00

191 lines
7.4 KiB
TypeScript
Generated

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "./utilities";
export class Network extends pulumi.CustomResource {
/**
* Get an existing Network 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.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkState, opts?: pulumi.CustomResourceOptions): Network {
return new Network(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'incus:index/network:Network';
/**
* Returns true if the given object is an instance of Network. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is Network {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Network.__pulumiType;
}
/**
* *Optional* - Map of key/value pairs of
* [network config settings](https://linuxcontainers.org/incus/docs/main/networks/).
*/
public readonly config!: pulumi.Output<{[key: string]: string}>;
/**
* *Optional* - Description of the network.
*/
public readonly description!: pulumi.Output<string>;
/**
* Whether or not the network is managed.
*/
public /*out*/ readonly managed!: pulumi.Output<boolean>;
/**
* **Required** - Name of the network. This is usually the device the
* network will appear as to instances.
*/
public readonly name!: pulumi.Output<string>;
/**
* *Optional* - Name of the project where the network will be created.
*/
public readonly project!: pulumi.Output<string>;
/**
* *Optional* - The remote in which the resource will be created. If
* not provided, the provider's default remote will be used.
*/
public readonly remote!: pulumi.Output<string | undefined>;
/**
* *Optional* - Specify a target node in a cluster.
*/
public readonly target!: pulumi.Output<string | undefined>;
/**
* *Optional* - The type of network to create. Can be one of: bridge,
* macvlan, sriov, ovn, or physical. If no type is specified, a bridge network
* is created.
*/
public readonly type!: pulumi.Output<string>;
/**
* Create a Network 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?: NetworkArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: NetworkArgs | NetworkState, opts?: pulumi.CustomResourceOptions) {
let resourceInputs: pulumi.Inputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState as NetworkState | undefined;
resourceInputs["config"] = state ? state.config : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["managed"] = state ? state.managed : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["remote"] = state ? state.remote : undefined;
resourceInputs["target"] = state ? state.target : undefined;
resourceInputs["type"] = state ? state.type : undefined;
} else {
const args = argsOrState as NetworkArgs | undefined;
resourceInputs["config"] = args ? args.config : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["project"] = (args ? args.project : undefined) ?? "default";
resourceInputs["remote"] = args ? args.remote : undefined;
resourceInputs["target"] = args ? args.target : undefined;
resourceInputs["type"] = args ? args.type : undefined;
resourceInputs["managed"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Network.__pulumiType, name, resourceInputs, opts);
}
}
/**
* Input properties used for looking up and filtering Network resources.
*/
export interface NetworkState {
/**
* *Optional* - Map of key/value pairs of
* [network config settings](https://linuxcontainers.org/incus/docs/main/networks/).
*/
config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* *Optional* - Description of the network.
*/
description?: pulumi.Input<string>;
/**
* Whether or not the network is managed.
*/
managed?: pulumi.Input<boolean>;
/**
* **Required** - Name of the network. This is usually the device the
* network will appear as to instances.
*/
name?: pulumi.Input<string>;
/**
* *Optional* - Name of the project where the network will be created.
*/
project?: pulumi.Input<string>;
/**
* *Optional* - The remote in which the resource will be created. If
* not provided, the provider's default remote will be used.
*/
remote?: pulumi.Input<string>;
/**
* *Optional* - Specify a target node in a cluster.
*/
target?: pulumi.Input<string>;
/**
* *Optional* - The type of network to create. Can be one of: bridge,
* macvlan, sriov, ovn, or physical. If no type is specified, a bridge network
* is created.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Network resource.
*/
export interface NetworkArgs {
/**
* *Optional* - Map of key/value pairs of
* [network config settings](https://linuxcontainers.org/incus/docs/main/networks/).
*/
config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* *Optional* - Description of the network.
*/
description?: pulumi.Input<string>;
/**
* **Required** - Name of the network. This is usually the device the
* network will appear as to instances.
*/
name?: pulumi.Input<string>;
/**
* *Optional* - Name of the project where the network will be created.
*/
project?: pulumi.Input<string>;
/**
* *Optional* - The remote in which the resource will be created. If
* not provided, the provider's default remote will be used.
*/
remote?: pulumi.Input<string>;
/**
* *Optional* - Specify a target node in a cluster.
*/
target?: pulumi.Input<string>;
/**
* *Optional* - The type of network to create. Can be one of: bridge,
* macvlan, sriov, ovn, or physical. If no type is specified, a bridge network
* is created.
*/
type?: pulumi.Input<string>;
}