@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
205 lines • 8.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `f5bigip.Do` provides details about bigip do resource
*
* This resource is helpful to configure do declarative JSON on BIG-IP.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
* import * as std from "@pulumi/std";
*
* const do_example = new f5bigip.Do("do-example", {
* doJson: std.file({
* input: "example.json",
* }).then(invoke => invoke.result),
* timeout: 15,
* });
* ```
*
* ## Importing
*
* Importing Existing DO declaration onto terraform can be done by using `task id` as `id`.
* An example is below:
* ```sh
* $ terraform import bigip_do.do-example2 2543dc37-bd1a-45c1-983f-1155a81489b2
* ```
*
* * `example.json` - Example of DO Declarative JSON
* * `DO documentation` - https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/composing-a-declaration.html#sample-declaration-for-a-standalone-big-ip
*/
export declare class Do extends pulumi.CustomResource {
/**
* Get an existing Do 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?: DoState, opts?: pulumi.CustomResourceOptions): Do;
/**
* Returns true if the given object is an instance of Do. 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 Do;
/**
* IP Address of BIGIP Host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
readonly bigipAddress: pulumi.Output<string | undefined>;
/**
* Password of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*
* * `timeout(minutes)` - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )
*
* > **Note:** If we want to replace provider BIGIP with other BIGIPs details we can specify with `bigipAddress`,
* `bigipUser`,`bigipPort` and `bigipPassword`. All Must be specified in such scenario.
*
* > **Note:** Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform
* state to empty and won't throw error.
*/
readonly bigipPassword: pulumi.Output<string | undefined>;
/**
* Port number of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
readonly bigipPort: pulumi.Output<string | undefined>;
/**
* Enable to use an external authentication source (LDAP, TACACS, etc)
*/
readonly bigipTokenAuth: pulumi.Output<boolean | undefined>;
/**
* UserName of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
readonly bigipUser: pulumi.Output<string | undefined>;
/**
* Name of the of the Declarative DO JSON file
*/
readonly doJson: pulumi.Output<string>;
/**
* unique identifier for DO resource
*
* @deprecated this attribute is no longer in use
*/
readonly tenantName: pulumi.Output<string | undefined>;
/**
* DO json
*/
readonly timeout: pulumi.Output<number | undefined>;
/**
* Create a Do 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: DoArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Do resources.
*/
export interface DoState {
/**
* IP Address of BIGIP Host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
bigipAddress?: pulumi.Input<string | undefined>;
/**
* Password of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*
* * `timeout(minutes)` - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )
*
* > **Note:** If we want to replace provider BIGIP with other BIGIPs details we can specify with `bigipAddress`,
* `bigipUser`,`bigipPort` and `bigipPassword`. All Must be specified in such scenario.
*
* > **Note:** Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform
* state to empty and won't throw error.
*/
bigipPassword?: pulumi.Input<string | undefined>;
/**
* Port number of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
bigipPort?: pulumi.Input<string | undefined>;
/**
* Enable to use an external authentication source (LDAP, TACACS, etc)
*/
bigipTokenAuth?: pulumi.Input<boolean | undefined>;
/**
* UserName of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
bigipUser?: pulumi.Input<string | undefined>;
/**
* Name of the of the Declarative DO JSON file
*/
doJson?: pulumi.Input<string | undefined>;
/**
* unique identifier for DO resource
*
* @deprecated this attribute is no longer in use
*/
tenantName?: pulumi.Input<string | undefined>;
/**
* DO json
*/
timeout?: pulumi.Input<number | undefined>;
}
/**
* The set of arguments for constructing a Do resource.
*/
export interface DoArgs {
/**
* IP Address of BIGIP Host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
bigipAddress?: pulumi.Input<string | undefined>;
/**
* Password of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*
* * `timeout(minutes)` - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )
*
* > **Note:** If we want to replace provider BIGIP with other BIGIPs details we can specify with `bigipAddress`,
* `bigipUser`,`bigipPort` and `bigipPassword`. All Must be specified in such scenario.
*
* > **Note:** Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform
* state to empty and won't throw error.
*/
bigipPassword?: pulumi.Input<string | undefined>;
/**
* Port number of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
bigipPort?: pulumi.Input<string | undefined>;
/**
* Enable to use an external authentication source (LDAP, TACACS, etc)
*/
bigipTokenAuth?: pulumi.Input<boolean | undefined>;
/**
* UserName of BIGIP host to be used for this resource,this is optional parameter.
* whenever we specify this parameter it gets overwrite provider configuration
*/
bigipUser?: pulumi.Input<string | undefined>;
/**
* Name of the of the Declarative DO JSON file
*/
doJson: pulumi.Input<string>;
/**
* unique identifier for DO resource
*
* @deprecated this attribute is no longer in use
*/
tenantName?: pulumi.Input<string | undefined>;
/**
* DO json
*/
timeout?: pulumi.Input<number | undefined>;
}
//# sourceMappingURL=do.d.ts.map