digitalocean.Provider
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:
- ApiEndpoint string
- The URL to use for the DigitalOcean API. It can also be sourced from the following environment variable: DIGITALOCEAN_API_URL
- HttpRetry intMax 
- The maximum number of retries on a failed API request.
- HttpRetry doubleWait Max 
- The maximum wait time (in seconds) between failed API requests.
- HttpRetry doubleWait Min 
- The minimum wait time (in seconds) between failed API requests.
- RequestsPer doubleSecond 
- The rate of requests per second to limit the HTTP client.
- SpacesAccess stringId 
- The access key ID for Spaces API operations.
- SpacesEndpoint string
- The URL to use for the DigitalOcean Spaces API. It can also be sourced from the following environment variable: SPACES_ENDPOINT_URL
- SpacesSecret stringKey 
- The secret access key for Spaces API operations.
- Token string
- The token key for API operations.
- ApiEndpoint string
- The URL to use for the DigitalOcean API. It can also be sourced from the following environment variable: DIGITALOCEAN_API_URL
- HttpRetry intMax 
- The maximum number of retries on a failed API request.
- HttpRetry float64Wait Max 
- The maximum wait time (in seconds) between failed API requests.
- HttpRetry float64Wait Min 
- The minimum wait time (in seconds) between failed API requests.
- RequestsPer float64Second 
- The rate of requests per second to limit the HTTP client.
- SpacesAccess stringId 
- The access key ID for Spaces API operations.
- SpacesEndpoint string
- The URL to use for the DigitalOcean Spaces API. It can also be sourced from the following environment variable: SPACES_ENDPOINT_URL
- SpacesSecret stringKey 
- The secret access key for Spaces API operations.
- Token string
- The token key for API operations.
- apiEndpoint String
- The URL to use for the DigitalOcean API. It can also be sourced from the following environment variable: DIGITALOCEAN_API_URL
- httpRetry IntegerMax 
- The maximum number of retries on a failed API request.
- httpRetry DoubleWait Max 
- The maximum wait time (in seconds) between failed API requests.
- httpRetry DoubleWait Min 
- The minimum wait time (in seconds) between failed API requests.
- requestsPer DoubleSecond 
- The rate of requests per second to limit the HTTP client.
- spacesAccess StringId 
- The access key ID for Spaces API operations.
- spacesEndpoint String
- The URL to use for the DigitalOcean Spaces API. It can also be sourced from the following environment variable: SPACES_ENDPOINT_URL
- spacesSecret StringKey 
- The secret access key for Spaces API operations.
- token String
- The token key for API operations.
- apiEndpoint string
- The URL to use for the DigitalOcean API. It can also be sourced from the following environment variable: DIGITALOCEAN_API_URL
- httpRetry numberMax 
- The maximum number of retries on a failed API request.
- httpRetry numberWait Max 
- The maximum wait time (in seconds) between failed API requests.
- httpRetry numberWait Min 
- The minimum wait time (in seconds) between failed API requests.
- requestsPer numberSecond 
- The rate of requests per second to limit the HTTP client.
- spacesAccess stringId 
- The access key ID for Spaces API operations.
- spacesEndpoint string
- The URL to use for the DigitalOcean Spaces API. It can also be sourced from the following environment variable: SPACES_ENDPOINT_URL
- spacesSecret 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.
- apiEndpoint String
- The URL to use for the DigitalOcean API. It can also be sourced from the following environment variable: DIGITALOCEAN_API_URL
- httpRetry NumberMax 
- The maximum number of retries on a failed API request.
- httpRetry NumberWait Max 
- The maximum wait time (in seconds) between failed API requests.
- httpRetry NumberWait Min 
- The minimum wait time (in seconds) between failed API requests.
- requestsPer NumberSecond 
- The rate of requests per second to limit the HTTP client.
- spacesAccess StringId 
- The access key ID for Spaces API operations.
- spacesEndpoint String
- The URL to use for the DigitalOcean Spaces API. It can also be sourced from the following environment variable: SPACES_ENDPOINT_URL
- spacesSecret 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.
Provider Resource Methods
TerraformConfig Method
This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
Using TerraformConfig
terraformConfig(): Output<Provider.TerraformConfigResult>def terraform_config() -> Output[Provider.Terraform_configResult]func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)public Output<Provider.TerraformConfigResult> TerraformConfig()TerraformConfig Result
- Result Dictionary<string, object>
- Result map[string]interface{}
- result Map<String,Object>
- result {[key: string]: any}
- result Mapping[str, Any]
- result Map<Any>
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the digitaloceanTerraform Provider.
