@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
184 lines (183 loc) • 6.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* `f5bigip.cm.DeviceGroup` A device group is a collection of BIG-IP devices that are configured to securely synchronize their BIG-IP configuration data, and fail over when needed.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const myNewDevicegroup = new f5bigip.cm.DeviceGroup("my_new_devicegroup", {
* name: "sanjose_devicegroup",
* autoSync: "enabled",
* fullLoadOnSync: "true",
* type: "sync-only",
* devices: [
* {
* name: "bigip1.cisco.com",
* },
* {
* name: "bigip200.f5.com",
* },
* ],
* });
* ```
*/
export declare class DeviceGroup extends pulumi.CustomResource {
/**
* Get an existing DeviceGroup 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?: DeviceGroupState, opts?: pulumi.CustomResourceOptions): DeviceGroup;
/**
* Returns true if the given object is an instance of DeviceGroup. 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 DeviceGroup;
/**
* Specifies if the device-group will automatically sync configuration data to its members
*/
readonly autoSync: pulumi.Output<string | undefined>;
/**
* Description of Device group
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of the device to be included in device group, this need to be configured before using devicegroup resource
*/
readonly devices: pulumi.Output<outputs.cm.DeviceGroupDevice[] | undefined>;
/**
* Specifies if the device-group will perform a full-load upon sync
*/
readonly fullLoadOnSync: pulumi.Output<string | undefined>;
/**
* Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
*/
readonly incrementalConfig: pulumi.Output<number | undefined>;
/**
* Is the name of the device Group
*/
readonly name: pulumi.Output<string | undefined>;
/**
* Specifies if the device-group will use a network connection for failover
*/
readonly networkFailover: pulumi.Output<string | undefined>;
/**
* Device administrative partition
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* Specifies whether the configuration should be saved upon auto-sync.
*/
readonly saveOnAutoSync: pulumi.Output<string | undefined>;
/**
* Specifies if the device-group will be used for failover or resource syncing
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Create a DeviceGroup 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?: DeviceGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DeviceGroup resources.
*/
export interface DeviceGroupState {
/**
* Specifies if the device-group will automatically sync configuration data to its members
*/
autoSync?: pulumi.Input<string>;
/**
* Description of Device group
*/
description?: pulumi.Input<string>;
/**
* Name of the device to be included in device group, this need to be configured before using devicegroup resource
*/
devices?: pulumi.Input<pulumi.Input<inputs.cm.DeviceGroupDevice>[]>;
/**
* Specifies if the device-group will perform a full-load upon sync
*/
fullLoadOnSync?: pulumi.Input<string>;
/**
* Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
*/
incrementalConfig?: pulumi.Input<number>;
/**
* Is the name of the device Group
*/
name?: pulumi.Input<string>;
/**
* Specifies if the device-group will use a network connection for failover
*/
networkFailover?: pulumi.Input<string>;
/**
* Device administrative partition
*/
partition?: pulumi.Input<string>;
/**
* Specifies whether the configuration should be saved upon auto-sync.
*/
saveOnAutoSync?: pulumi.Input<string>;
/**
* Specifies if the device-group will be used for failover or resource syncing
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DeviceGroup resource.
*/
export interface DeviceGroupArgs {
/**
* Specifies if the device-group will automatically sync configuration data to its members
*/
autoSync?: pulumi.Input<string>;
/**
* Description of Device group
*/
description?: pulumi.Input<string>;
/**
* Name of the device to be included in device group, this need to be configured before using devicegroup resource
*/
devices?: pulumi.Input<pulumi.Input<inputs.cm.DeviceGroupDevice>[]>;
/**
* Specifies if the device-group will perform a full-load upon sync
*/
fullLoadOnSync?: pulumi.Input<string>;
/**
* Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. The default is 1024 KB.
*/
incrementalConfig?: pulumi.Input<number>;
/**
* Is the name of the device Group
*/
name?: pulumi.Input<string>;
/**
* Specifies if the device-group will use a network connection for failover
*/
networkFailover?: pulumi.Input<string>;
/**
* Device administrative partition
*/
partition?: pulumi.Input<string>;
/**
* Specifies whether the configuration should be saved upon auto-sync.
*/
saveOnAutoSync?: pulumi.Input<string>;
/**
* Specifies if the device-group will be used for failover or resource syncing
*/
type?: pulumi.Input<string>;
}