civo.Provider
Explore with Pulumi AI
The provider type for the civo package. By default, resources use package-wide configuration
settings, however an explicit Provider
instance may be created and passed during resource
construction to achieve fine-grained programmatic control over provider settings. See the
documentation for more information.
Create Provider Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
args: Optional[ProviderArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Provider(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_endpoint: Optional[str] = None,
credentials_file: Optional[str] = None,
region: Optional[str] = None,
token: Optional[str] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:civo
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 ProviderArgs
- 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 ProviderArgs
- 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 ProviderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProviderArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Provider 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 Provider resource accepts the following input properties:
- Api
Endpoint string - The Base URL to use for CIVO API.
- Credentials
File string - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE environment variable.
- Region string
- If region is not set, then no region will be used and them you need expensify in every resource even if you expensify here you can overwrite in a resource.
- Token string
- This is the Civo API token. Alternatively, this can also be specified using
CIVO_TOKEN
environment variable.
- Api
Endpoint string - The Base URL to use for CIVO API.
- Credentials
File string - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE environment variable.
- Region string
- If region is not set, then no region will be used and them you need expensify in every resource even if you expensify here you can overwrite in a resource.
- Token string
- This is the Civo API token. Alternatively, this can also be specified using
CIVO_TOKEN
environment variable.
- api
Endpoint String - The Base URL to use for CIVO API.
- credentials
File String - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE environment variable.
- region String
- If region is not set, then no region will be used and them you need expensify in every resource even if you expensify here you can overwrite in a resource.
- token String
- This is the Civo API token. Alternatively, this can also be specified using
CIVO_TOKEN
environment variable.
- api
Endpoint string - The Base URL to use for CIVO API.
- credentials
File string - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE environment variable.
- region string
- If region is not set, then no region will be used and them you need expensify in every resource even if you expensify here you can overwrite in a resource.
- token string
- This is the Civo API token. Alternatively, this can also be specified using
CIVO_TOKEN
environment variable.
- api_
endpoint str - The Base URL to use for CIVO API.
- credentials_
file str - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE environment variable.
- region str
- If region is not set, then no region will be used and them you need expensify in every resource even if you expensify here you can overwrite in a resource.
- token str
- This is the Civo API token. Alternatively, this can also be specified using
CIVO_TOKEN
environment variable.
- api
Endpoint String - The Base URL to use for CIVO API.
- credentials
File String - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE environment variable.
- region String
- If region is not set, then no region will be used and them you need expensify in every resource even if you expensify here you can overwrite in a resource.
- token String
- This is the Civo API token. Alternatively, this can also be specified using
CIVO_TOKEN
environment variable.
Outputs
All input properties are implicitly available as output properties. Additionally, the Provider 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.
Package Details
- Repository
- Civo pulumi/pulumi-civo
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
civo
Terraform Provider.