UNPKG

@pulumi/f5bigip

Version:

A Pulumi package for creating and managing F5 BigIP resources.

179 lines (178 loc) 5.91 kB
import * as pulumi from "@pulumi/pulumi"; /** * `f5bigip.net.SelfIp` Manages a selfip configuration * * Resource should be named with their `full path`. The full path is the combination of the `partition + name of the resource`, for example `/Common/my-selfip`. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as f5bigip from "@pulumi/f5bigip"; * * const vlan1 = new f5bigip.net.Vlan("vlan1", { * name: "/Common/Internal", * tag: 101, * interfaces: [{ * vlanport: "1.2", * tagged: false, * }], * }); * const selfip1 = new f5bigip.net.SelfIp("selfip1", { * name: "/Common/internalselfIP", * ip: "11.1.1.1/24", * vlan: "/Common/internal", * }, { * dependsOn: [vlan1], * }); * ``` * ### Example usage with `portLockdown` * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as f5bigip from "@pulumi/f5bigip"; * * const selfip1 = new f5bigip.net.SelfIp("selfip1", { * name: "/Common/internalselfIP", * ip: "11.1.1.1/24", * vlan: "/Common/internal", * trafficGroup: "traffic-group-1", * portLockdowns: [ * "tcp:4040", * "udp:5050", * "egp:0", * ], * }, { * dependsOn: [vlan1], * }); * ``` * * ### Example usage with `portLockdown` set to `["none"]` * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as f5bigip from "@pulumi/f5bigip"; * * const selfip1 = new f5bigip.net.SelfIp("selfip1", { * name: "/Common/internalselfIP", * ip: "11.1.1.1/24", * vlan: "/Common/internal", * trafficGroup: "traffic-group-1", * portLockdowns: ["none"], * }, { * dependsOn: [vlan1], * }); * ``` * * ### Example usage with route domain embedded in the `ip` * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as f5bigip from "@pulumi/f5bigip"; * * const selfip1 = new f5bigip.net.SelfIp("selfip1", { * name: "/Common/internalselfIP", * ip: "11.1.1.1%4/24", * vlan: "/Common/internal", * trafficGroup: "traffic-group-1", * portLockdowns: ["none"], * }, { * dependsOn: [vlan1], * }); * ``` */ export declare class SelfIp extends pulumi.CustomResource { /** * Get an existing SelfIp 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?: SelfIpState, opts?: pulumi.CustomResourceOptions): SelfIp; /** * Returns true if the given object is an instance of SelfIp. 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 SelfIp; /** * The Self IP's address and netmask. The IP address could also contain the route domain, e.g. `10.12.13.14%4/24`. */ readonly ip: pulumi.Output<string>; /** * Name of the selfip */ readonly name: pulumi.Output<string>; /** * Specifies the port lockdown, defaults to `Allow None` if not specified. */ readonly portLockdowns: pulumi.Output<string[] | undefined>; /** * Specifies the traffic group, defaults to `traffic-group-local-only` if not specified. */ readonly trafficGroup: pulumi.Output<string | undefined>; /** * Specifies the VLAN for which you are setting a self IP address. This setting must be provided when a self IP is created. */ readonly vlan: pulumi.Output<string>; /** * Create a SelfIp 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: SelfIpArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SelfIp resources. */ export interface SelfIpState { /** * The Self IP's address and netmask. The IP address could also contain the route domain, e.g. `10.12.13.14%4/24`. */ ip?: pulumi.Input<string>; /** * Name of the selfip */ name?: pulumi.Input<string>; /** * Specifies the port lockdown, defaults to `Allow None` if not specified. */ portLockdowns?: pulumi.Input<pulumi.Input<string>[]>; /** * Specifies the traffic group, defaults to `traffic-group-local-only` if not specified. */ trafficGroup?: pulumi.Input<string>; /** * Specifies the VLAN for which you are setting a self IP address. This setting must be provided when a self IP is created. */ vlan?: pulumi.Input<string>; } /** * The set of arguments for constructing a SelfIp resource. */ export interface SelfIpArgs { /** * The Self IP's address and netmask. The IP address could also contain the route domain, e.g. `10.12.13.14%4/24`. */ ip: pulumi.Input<string>; /** * Name of the selfip */ name: pulumi.Input<string>; /** * Specifies the port lockdown, defaults to `Allow None` if not specified. */ portLockdowns?: pulumi.Input<pulumi.Input<string>[]>; /** * Specifies the traffic group, defaults to `traffic-group-local-only` if not specified. */ trafficGroup?: pulumi.Input<string>; /** * Specifies the VLAN for which you are setting a self IP address. This setting must be provided when a self IP is created. */ vlan: pulumi.Input<string>; }