1. Packages
  2. Datadog Provider
  3. API Docs
  4. Provider
Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi

datadog.Provider

Explore with Pulumi AI

datadog logo
Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi

    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 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_key: Optional[str] = None,
                 api_url: Optional[str] = None,
                 app_key: Optional[str] = None,
                 default_tags: Optional[ProviderDefaultTagsArgs] = None,
                 http_client_retry_backoff_base: Optional[int] = None,
                 http_client_retry_backoff_multiplier: Optional[int] = None,
                 http_client_retry_enabled: Optional[str] = None,
                 http_client_retry_max_retries: Optional[int] = None,
                 http_client_retry_timeout: Optional[int] = None,
                 validate: 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:datadog
    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:

    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, and defaults to https://api.datadoghq.com. 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/. Other Datadog region examples: https://api.us5.datadoghq.com/, https://api.us3.datadoghq.com/ and https://api.ddog-gov.com/. See https://docs.datadoghq.com/getting_started/site/ for all available regions.
    AppKey string
    (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
    DefaultTags ProviderDefaultTags
    [Experimental - Monitors only] Configuration block containing settings to apply default resource tags across all resources.
    HttpClientRetryBackoffBase int
    The HTTP request retry back off base. Defaults to 2.
    HttpClientRetryBackoffMultiplier int
    The HTTP request retry back off multiplier. Defaults to 2.
    HttpClientRetryEnabled string
    Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
    HttpClientRetryMaxRetries int
    The HTTP request maximum retry number. Defaults to 3.
    HttpClientRetryTimeout int
    The HTTP request retry timeout period. Defaults to 60 seconds.
    Validate string
    Enables validation of the provided API key during provider initialization. Valid values are [true, false]. Default is true. When false, api_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, and defaults to https://api.datadoghq.com. 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/. Other Datadog region examples: https://api.us5.datadoghq.com/, https://api.us3.datadoghq.com/ and https://api.ddog-gov.com/. See https://docs.datadoghq.com/getting_started/site/ for all available regions.
    AppKey string
    (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
    DefaultTags ProviderDefaultTagsArgs
    [Experimental - Monitors only] Configuration block containing settings to apply default resource tags across all resources.
    HttpClientRetryBackoffBase int
    The HTTP request retry back off base. Defaults to 2.
    HttpClientRetryBackoffMultiplier int
    The HTTP request retry back off multiplier. Defaults to 2.
    HttpClientRetryEnabled string
    Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
    HttpClientRetryMaxRetries int
    The HTTP request maximum retry number. Defaults to 3.
    HttpClientRetryTimeout int
    The HTTP request retry timeout period. Defaults to 60 seconds.
    Validate string
    Enables validation of the provided API key during provider initialization. Valid values are [true, false]. Default is true. When false, api_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, and defaults to https://api.datadoghq.com. 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/. Other Datadog region examples: https://api.us5.datadoghq.com/, https://api.us3.datadoghq.com/ and https://api.ddog-gov.com/. See https://docs.datadoghq.com/getting_started/site/ for all available regions.
    appKey String
    (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
    defaultTags ProviderDefaultTags
    [Experimental - Monitors only] Configuration block containing settings to apply default resource tags across all resources.
    httpClientRetryBackoffBase Integer
    The HTTP request retry back off base. Defaults to 2.
    httpClientRetryBackoffMultiplier Integer
    The HTTP request retry back off multiplier. Defaults to 2.
    httpClientRetryEnabled String
    Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
    httpClientRetryMaxRetries Integer
    The HTTP request maximum retry number. Defaults to 3.
    httpClientRetryTimeout Integer
    The HTTP request retry timeout period. Defaults to 60 seconds.
    validate String
    Enables validation of the provided API key during provider initialization. Valid values are [true, false]. Default is true. When false, api_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, and defaults to https://api.datadoghq.com. 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/. Other Datadog region examples: https://api.us5.datadoghq.com/, https://api.us3.datadoghq.com/ and https://api.ddog-gov.com/. See https://docs.datadoghq.com/getting_started/site/ for all available regions.
    appKey string
    (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
    defaultTags ProviderDefaultTags
    [Experimental - Monitors only] Configuration block containing settings to apply default resource tags across all resources.
    httpClientRetryBackoffBase number
    The HTTP request retry back off base. Defaults to 2.
    httpClientRetryBackoffMultiplier number
    The HTTP request retry back off multiplier. Defaults to 2.
    httpClientRetryEnabled string
    Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
    httpClientRetryMaxRetries number
    The HTTP request maximum retry number. Defaults to 3.
    httpClientRetryTimeout number
    The HTTP request retry timeout period. Defaults to 60 seconds.
    validate string
    Enables validation of the provided API key during provider initialization. Valid values are [true, false]. Default is true. When false, api_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, and defaults to https://api.datadoghq.com. 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/. Other Datadog region examples: https://api.us5.datadoghq.com/, https://api.us3.datadoghq.com/ and https://api.ddog-gov.com/. See https://docs.datadoghq.com/getting_started/site/ for all available regions.
    app_key str
    (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
    default_tags ProviderDefaultTagsArgs
    [Experimental - Monitors only] Configuration block containing settings to apply default resource tags across all resources.
    http_client_retry_backoff_base int
    The HTTP request retry back off base. Defaults to 2.
    http_client_retry_backoff_multiplier int
    The HTTP request retry back off multiplier. Defaults to 2.
    http_client_retry_enabled str
    Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
    http_client_retry_max_retries int
    The HTTP request maximum retry number. Defaults to 3.
    http_client_retry_timeout int
    The HTTP request retry timeout period. Defaults to 60 seconds.
    validate str
    Enables validation of the provided API key during provider initialization. Valid values are [true, false]. Default is true. When false, api_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, and defaults to https://api.datadoghq.com. 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/. Other Datadog region examples: https://api.us5.datadoghq.com/, https://api.us3.datadoghq.com/ and https://api.ddog-gov.com/. See https://docs.datadoghq.com/getting_started/site/ for all available regions.
    appKey String
    (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
    defaultTags Property Map
    [Experimental - Monitors only] Configuration block containing settings to apply default resource tags across all resources.
    httpClientRetryBackoffBase Number
    The HTTP request retry back off base. Defaults to 2.
    httpClientRetryBackoffMultiplier Number
    The HTTP request retry back off multiplier. Defaults to 2.
    httpClientRetryEnabled String
    Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
    httpClientRetryMaxRetries Number
    The HTTP request maximum retry number. Defaults to 3.
    httpClientRetryTimeout Number
    The HTTP request retry timeout period. Defaults to 60 seconds.
    validate String
    Enables validation of the provided API key during provider initialization. Valid values are [true, false]. Default is true. When false, api_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 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.

    Supporting Types

    ProviderDefaultTags, ProviderDefaultTagsArgs

    Tags Dictionary<string, string>
    [Experimental - Monitors only] Resource tags to be applied by default across all resources.
    Tags map[string]string
    [Experimental - Monitors only] Resource tags to be applied by default across all resources.
    tags Map<String,String>
    [Experimental - Monitors only] Resource tags to be applied by default across all resources.
    tags {[key: string]: string}
    [Experimental - Monitors only] Resource tags to be applied by default across all resources.
    tags Mapping[str, str]
    [Experimental - Monitors only] Resource tags to be applied by default across all resources.
    tags Map<String>
    [Experimental - Monitors only] Resource tags to be applied by default across all resources.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi