digitalocean.Provider
Explore with Pulumi AI
The provider type for the digitalocean 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,
http_retry_max: Optional[int] = None,
http_retry_wait_max: Optional[float] = None,
http_retry_wait_min: Optional[float] = None,
requests_per_second: Optional[float] = None,
spaces_access_id: Optional[str] = None,
spaces_endpoint: Optional[str] = None,
spaces_secret_key: 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:digitalocean
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 URL to use for the DigitalOcean API.
It can also be sourced from the following environment variable:
DIGITALOCEAN_API_URL
- Http
Retry intMax - The maximum number of retries on a failed API request.
- Http
Retry doubleWait Max - The maximum wait time (in seconds) between failed API requests.
- Http
Retry doubleWait Min - The minimum wait time (in seconds) between failed API requests.
- Requests
Per doubleSecond - The rate of requests per second to limit the HTTP client.
- Spaces
Access stringId - The access key ID for Spaces API operations.
- Spaces
Endpoint string - The URL to use for the DigitalOcean Spaces API.
It can also be sourced from the following environment variable:
SPACES_ENDPOINT_URL
- Spaces
Secret stringKey - The secret access key for Spaces API operations.
- Token string
- The token key for API operations.
- Api
Endpoint string - The URL to use for the DigitalOcean API.
It can also be sourced from the following environment variable:
DIGITALOCEAN_API_URL
- Http
Retry intMax - The maximum number of retries on a failed API request.
- Http
Retry float64Wait Max - The maximum wait time (in seconds) between failed API requests.
- Http
Retry float64Wait Min - The minimum wait time (in seconds) between failed API requests.
- Requests
Per float64Second - The rate of requests per second to limit the HTTP client.
- Spaces
Access stringId - The access key ID for Spaces API operations.
- Spaces
Endpoint string - The URL to use for the DigitalOcean Spaces API.
It can also be sourced from the following environment variable:
SPACES_ENDPOINT_URL
- Spaces
Secret stringKey - The secret access key for Spaces API operations.
- Token string
- The token key for API operations.
- api
Endpoint String - The URL to use for the DigitalOcean API.
It can also be sourced from the following environment variable:
DIGITALOCEAN_API_URL
- http
Retry IntegerMax - The maximum number of retries on a failed API request.
- http
Retry DoubleWait Max - The maximum wait time (in seconds) between failed API requests.
- http
Retry DoubleWait Min - The minimum wait time (in seconds) between failed API requests.
- requests
Per DoubleSecond - The rate of requests per second to limit the HTTP client.
- spaces
Access StringId - The access key ID for Spaces API operations.
- spaces
Endpoint String - The URL to use for the DigitalOcean Spaces API.
It can also be sourced from the following environment variable:
SPACES_ENDPOINT_URL
- spaces
Secret StringKey - The secret access key for Spaces API operations.
- token String
- The token key for API operations.
- api
Endpoint string - The URL to use for the DigitalOcean API.
It can also be sourced from the following environment variable:
DIGITALOCEAN_API_URL
- http
Retry numberMax - The maximum number of retries on a failed API request.
- http
Retry numberWait Max - The maximum wait time (in seconds) between failed API requests.
- http
Retry numberWait Min - The minimum wait time (in seconds) between failed API requests.
- requests
Per numberSecond - The rate of requests per second to limit the HTTP client.
- spaces
Access stringId - The access key ID for Spaces API operations.
- spaces
Endpoint string - The URL to use for the DigitalOcean Spaces API.
It can also be sourced from the following environment variable:
SPACES_ENDPOINT_URL
- spaces
Secret stringKey - The secret access key for Spaces API operations.
- token string
- The token key for API operations.
- api_
endpoint str - The URL to use for the DigitalOcean API.
It can also be sourced from the following environment variable:
DIGITALOCEAN_API_URL
- http_
retry_ intmax - The maximum number of retries on a failed API request.
- http_
retry_ floatwait_ max - The maximum wait time (in seconds) between failed API requests.
- http_
retry_ floatwait_ min - The minimum wait time (in seconds) between failed API requests.
- requests_
per_ floatsecond - The rate of requests per second to limit the HTTP client.
- spaces_
access_ strid - The access key ID for Spaces API operations.
- spaces_
endpoint str - The URL to use for the DigitalOcean Spaces API.
It can also be sourced from the following environment variable:
SPACES_ENDPOINT_URL
- spaces_
secret_ strkey - The secret access key for Spaces API operations.
- token str
- The token key for API operations.
- api
Endpoint String - The URL to use for the DigitalOcean API.
It can also be sourced from the following environment variable:
DIGITALOCEAN_API_URL
- http
Retry NumberMax - The maximum number of retries on a failed API request.
- http
Retry NumberWait Max - The maximum wait time (in seconds) between failed API requests.
- http
Retry NumberWait Min - The minimum wait time (in seconds) between failed API requests.
- requests
Per NumberSecond - The rate of requests per second to limit the HTTP client.
- spaces
Access StringId - The access key ID for Spaces API operations.
- spaces
Endpoint String - The URL to use for the DigitalOcean Spaces API.
It can also be sourced from the following environment variable:
SPACES_ENDPOINT_URL
- spaces
Secret StringKey - The secret access key for Spaces API operations.
- token String
- The token key for API operations.
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
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
digitalocean
Terraform Provider.