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

209 lines
8.2 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";
/**
* ## # incus.NetworkIntegration
*
* Manage integrations between the local Incus deployment and remote networks hosted on Incus or other platforms. Currently available only for [OVN networks](https://linuxcontainers.org/incus/docs/main/reference/network_ovn/#network-ovn).
*
* ## Basic Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as incus from "@kiterun/incus";
*
* const _this = new incus.NetworkIntegration("this", {
* name: "ovn-region",
* type: "ovn",
* config: {
* "ovn.northbound_connection": "tcp:[192.0.2.12]:6645,tcp:[192.0.3.13]:6645,tcp:[192.0.3.14]:6645",
* "ovn.southbound_connection": "tcp:[192.0.2.12]:6646,tcp:[192.0.3.13]:6646,tcp:[192.0.3.14]:6646",
* },
* });
* ```
*
* ## Peer Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as incus from "@kiterun/incus";
*
* const _default = new incus.Network("default", {
* name: "default",
* type: "ovn",
* config: {
* "ipv4.address": "192.168.2.0/24",
* "ipv4.nat": "true",
* },
* });
* const _this = new incus.NetworkIntegration("this", {
* name: "ovn-region",
* type: "ovn",
* config: {
* "ovn.northbound_connection": "tcp:[192.0.2.12]:6645,tcp:[192.0.3.13]:6645,tcp:[192.0.3.14]:6645",
* "ovn.southbound_connection": "tcp:[192.0.2.12]:6646,tcp:[192.0.3.13]:6646,tcp:[192.0.3.14]:6646",
* },
* });
* const thisNetworkPeer = new incus.NetworkPeer("this", {
* name: "ovn-peer",
* network: _default.name,
* targetIntegration: _this.name,
* type: "remote",
* });
* ```
*/
export class NetworkIntegration extends pulumi.CustomResource {
/**
* Get an existing NetworkIntegration 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?: NetworkIntegrationState, opts?: pulumi.CustomResourceOptions): NetworkIntegration {
return new NetworkIntegration(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'incus:index/networkIntegration:NetworkIntegration';
/**
* Returns true if the given object is an instance of NetworkIntegration. 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 NetworkIntegration {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === NetworkIntegration.__pulumiType;
}
/**
* *Optional* - Map of key/value pairs of [network integration config settings](https://linuxcontainers.org/incus/docs/main/howto/network_integrations/)
*/
public readonly config!: pulumi.Output<{[key: string]: string}>;
/**
* *Optional* - Description of the network integration.
*/
public readonly description!: pulumi.Output<string>;
/**
* **Required** - Name of the network integration.
*/
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>;
/**
* **Required** - The type of the network integration. Currently, only supports `ovn` type.
*/
public readonly type!: pulumi.Output<string>;
/**
* Create a NetworkIntegration 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: NetworkIntegrationArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: NetworkIntegrationArgs | NetworkIntegrationState, opts?: pulumi.CustomResourceOptions) {
let resourceInputs: pulumi.Inputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState as NetworkIntegrationState | undefined;
resourceInputs["config"] = state ? state.config : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["remote"] = state ? state.remote : undefined;
resourceInputs["type"] = state ? state.type : undefined;
} else {
const args = argsOrState as NetworkIntegrationArgs | undefined;
if ((!args || args.type === undefined) && !opts.urn) {
throw new Error("Missing required property 'type'");
}
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["type"] = args ? args.type : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(NetworkIntegration.__pulumiType, name, resourceInputs, opts);
}
}
/**
* Input properties used for looking up and filtering NetworkIntegration resources.
*/
export interface NetworkIntegrationState {
/**
* *Optional* - Map of key/value pairs of [network integration config settings](https://linuxcontainers.org/incus/docs/main/howto/network_integrations/)
*/
config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* *Optional* - Description of the network integration.
*/
description?: pulumi.Input<string>;
/**
* **Required** - Name of the network integration.
*/
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>;
/**
* **Required** - The type of the network integration. Currently, only supports `ovn` type.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NetworkIntegration resource.
*/
export interface NetworkIntegrationArgs {
/**
* *Optional* - Map of key/value pairs of [network integration config settings](https://linuxcontainers.org/incus/docs/main/howto/network_integrations/)
*/
config?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* *Optional* - Description of the network integration.
*/
description?: pulumi.Input<string>;
/**
* **Required** - Name of the network integration.
*/
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>;
/**
* **Required** - The type of the network integration. Currently, only supports `ovn` type.
*/
type: pulumi.Input<string>;
}