Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Provider

The provider type for the datadog 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 a Provider Resource

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
def Provider(resource_name: str, opts: Optional[ResourceOptions] = None, api_key: Optional[str] = None, api_url: Optional[str] = None, app_key: Optional[str] = None, validate: Optional[bool] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

ApiKey string

(Required unless validate is false) Datadog API key. This can also be set via the DD_API_KEY environment variable.

ApiUrl string

The API Url. This can also be set via the DD_HOST environment variable. Note that this URL must not end with the /api/ path. For example, https://api.datadoghq.com/ is a correct value, while https://api.datadoghq.com/api/ is not. And if you’re working with “EU” version of Datadog, use https://api.datadoghq.eu/.

AppKey string

(Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.

Validate bool

Enables validation of the provided API and APP keys during provider initialization. Default is true. When false, api_key and app_key won’t be checked.

ApiKey string

(Required unless validate is false) Datadog API key. This can also be set via the DD_API_KEY environment variable.

ApiUrl string

The API Url. This can also be set via the DD_HOST environment variable. Note that this URL must not end with the /api/ path. For example, https://api.datadoghq.com/ is a correct value, while https://api.datadoghq.com/api/ is not. And if you’re working with “EU” version of Datadog, use https://api.datadoghq.eu/.

AppKey string

(Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.

Validate bool

Enables validation of the provided API and APP keys during provider initialization. Default is true. When false, api_key and app_key won’t be checked.

apiKey string

(Required unless validate is false) Datadog API key. This can also be set via the DD_API_KEY environment variable.

apiUrl string

The API Url. This can also be set via the DD_HOST environment variable. Note that this URL must not end with the /api/ path. For example, https://api.datadoghq.com/ is a correct value, while https://api.datadoghq.com/api/ is not. And if you’re working with “EU” version of Datadog, use https://api.datadoghq.eu/.

appKey string

(Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.

validate boolean

Enables validation of the provided API and APP keys during provider initialization. Default is true. When false, api_key and app_key won’t be checked.

api_key str

(Required unless validate is false) Datadog API key. This can also be set via the DD_API_KEY environment variable.

api_url str

The API Url. This can also be set via the DD_HOST environment variable. Note that this URL must not end with the /api/ path. For example, https://api.datadoghq.com/ is a correct value, while https://api.datadoghq.com/api/ is not. And if you’re working with “EU” version of Datadog, use https://api.datadoghq.eu/.

app_key str

(Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.

validate bool

Enables validation of the provided API and APP keys during provider initialization. Default is true. When false, api_key and app_key won’t be checked.

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 str
The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-datadog
License
Apache-2.0
Notes
This Pulumi package is based on the datadog Terraform Provider.