Docs Home
f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi
f5bigip.Do
Explore with Pulumi AI
Create Do Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Do(name: string, args: DoArgs, opts?: CustomResourceOptions);@overload
def Do(resource_name: str,
args: DoArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Do(resource_name: str,
opts: Optional[ResourceOptions] = None,
do_json: Optional[str] = None,
bigip_address: Optional[str] = None,
bigip_password: Optional[str] = None,
bigip_port: Optional[str] = None,
bigip_token_auth: Optional[bool] = None,
bigip_user: Optional[str] = None,
tenant_name: Optional[str] = None,
timeout: Optional[int] = None)func NewDo(ctx *Context, name string, args DoArgs, opts ...ResourceOption) (*Do, error)public Do(string name, DoArgs args, CustomResourceOptions? opts = null)type: f5bigip:Do
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DoArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DoArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DoArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DoArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DoArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var doResource = new F5BigIP.Do("doResource", new()
{
DoJson = "string",
BigipAddress = "string",
BigipPassword = "string",
BigipPort = "string",
BigipTokenAuth = false,
BigipUser = "string",
Timeout = 0,
});
example, err := f5bigip.NewDo(ctx, "doResource", &f5bigip.DoArgs{
DoJson: pulumi.String("string"),
BigipAddress: pulumi.String("string"),
BigipPassword: pulumi.String("string"),
BigipPort: pulumi.String("string"),
BigipTokenAuth: pulumi.Bool(false),
BigipUser: pulumi.String("string"),
Timeout: pulumi.Int(0),
})
var doResource = new Do("doResource", DoArgs.builder()
.doJson("string")
.bigipAddress("string")
.bigipPassword("string")
.bigipPort("string")
.bigipTokenAuth(false)
.bigipUser("string")
.timeout(0)
.build());
do_resource = f5bigip.Do("doResource",
do_json="string",
bigip_address="string",
bigip_password="string",
bigip_port="string",
bigip_token_auth=False,
bigip_user="string",
timeout=0)
const doResource = new f5bigip.Do("doResource", {
doJson: "string",
bigipAddress: "string",
bigipPassword: "string",
bigipPort: "string",
bigipTokenAuth: false,
bigipUser: "string",
timeout: 0,
});
type: f5bigip:Do
properties:
bigipAddress: string
bigipPassword: string
bigipPort: string
bigipTokenAuth: false
bigipUser: string
doJson: string
timeout: 0
Do Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Do resource accepts the following input properties:
- Do
Json string - Name of the of the Declarative DO JSON file
- Bigip
Address string - 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
- Bigip
Password string - Password of BIGIP host to be used for this resource
- Bigip
Port string - 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
- Bigip
Token boolAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- Bigip
User string - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- Tenant
Name string - unique identifier for DO resource
- Timeout int
- DO json
- Do
Json string - Name of the of the Declarative DO JSON file
- Bigip
Address string - 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
- Bigip
Password string - Password of BIGIP host to be used for this resource
- Bigip
Port string - 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
- Bigip
Token boolAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- Bigip
User string - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- Tenant
Name string - unique identifier for DO resource
- Timeout int
- DO json
- do
Json String - Name of the of the Declarative DO JSON file
- bigip
Address String - 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
- bigip
Password String - Password of BIGIP host to be used for this resource
- bigip
Port String - 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
- bigip
Token BooleanAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip
User String - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- tenant
Name String - unique identifier for DO resource
- timeout Integer
- DO json
- do
Json string - Name of the of the Declarative DO JSON file
- bigip
Address string - 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
- bigip
Password string - Password of BIGIP host to be used for this resource
- bigip
Port string - 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
- bigip
Token booleanAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip
User string - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- tenant
Name string - unique identifier for DO resource
- timeout number
- DO json
- do_
json str - Name of the of the Declarative DO JSON file
- bigip_
address str - 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
- bigip_
password str - Password of BIGIP host to be used for this resource
- bigip_
port str - 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
- bigip_
token_ boolauth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip_
user str - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- tenant_
name str - unique identifier for DO resource
- timeout int
- DO json
- do
Json String - Name of the of the Declarative DO JSON file
- bigip
Address String - 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
- bigip
Password String - Password of BIGIP host to be used for this resource
- bigip
Port String - 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
- bigip
Token BooleanAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip
User String - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- tenant
Name String - unique identifier for DO resource
- timeout Number
- DO json
Outputs
All input properties are implicitly available as output properties. Additionally, the Do resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Do Resource
Get an existing Do resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DoState, opts?: CustomResourceOptions): Do@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bigip_address: Optional[str] = None,
bigip_password: Optional[str] = None,
bigip_port: Optional[str] = None,
bigip_token_auth: Optional[bool] = None,
bigip_user: Optional[str] = None,
do_json: Optional[str] = None,
tenant_name: Optional[str] = None,
timeout: Optional[int] = None) -> Dofunc GetDo(ctx *Context, name string, id IDInput, state *DoState, opts ...ResourceOption) (*Do, error)public static Do Get(string name, Input<string> id, DoState? state, CustomResourceOptions? opts = null)public static Do get(String name, Output<String> id, DoState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Bigip
Address string - 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
- Bigip
Password string - Password of BIGIP host to be used for this resource
- Bigip
Port string - 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
- Bigip
Token boolAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- Bigip
User string - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- Do
Json string - Name of the of the Declarative DO JSON file
- Tenant
Name string - unique identifier for DO resource
- Timeout int
- DO json
- Bigip
Address string - 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
- Bigip
Password string - Password of BIGIP host to be used for this resource
- Bigip
Port string - 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
- Bigip
Token boolAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- Bigip
User string - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- Do
Json string - Name of the of the Declarative DO JSON file
- Tenant
Name string - unique identifier for DO resource
- Timeout int
- DO json
- bigip
Address String - 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
- bigip
Password String - Password of BIGIP host to be used for this resource
- bigip
Port String - 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
- bigip
Token BooleanAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip
User String - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- do
Json String - Name of the of the Declarative DO JSON file
- tenant
Name String - unique identifier for DO resource
- timeout Integer
- DO json
- bigip
Address string - 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
- bigip
Password string - Password of BIGIP host to be used for this resource
- bigip
Port string - 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
- bigip
Token booleanAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip
User string - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- do
Json string - Name of the of the Declarative DO JSON file
- tenant
Name string - unique identifier for DO resource
- timeout number
- DO json
- bigip_
address str - 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
- bigip_
password str - Password of BIGIP host to be used for this resource
- bigip_
port str - 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
- bigip_
token_ boolauth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip_
user str - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- do_
json str - Name of the of the Declarative DO JSON file
- tenant_
name str - unique identifier for DO resource
- timeout int
- DO json
- bigip
Address String - 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
- bigip
Password String - Password of BIGIP host to be used for this resource
- bigip
Port String - 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
- bigip
Token BooleanAuth - Enable to use an external authentication source (LDAP, TACACS, etc)
- bigip
User String - UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
- do
Json String - Name of the of the Declarative DO JSON file
- tenant
Name String - unique identifier for DO resource
- timeout Number
- DO json
Package Details
- Repository
- f5 BIG-IP pulumi/pulumi-f5bigip
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
bigipTerraform Provider.