Skip to content

Latest commit

 

History

History
917 lines (575 loc) · 36.7 KB

provider.csharp.md

File metadata and controls

917 lines (575 loc) · 36.7 KB
Raw

provider Submodule

Constructs

DatadogProvider

Represents a {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs datadog}.

Initializers 

using HashiCorp.Cdktf.Providers.Datadog;

new DatadogProvider(Construct Scope, string Id, DatadogProviderConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DatadogProviderConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigOptional

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
ResetAlias No description.
ResetApiKey No description.
ResetApiUrl No description.
ResetAppKey No description.
ResetDefaultTags No description.
ResetHttpClientRetryBackoffBase No description.
ResetHttpClientRetryBackoffMultiplier No description.
ResetHttpClientRetryEnabled No description.
ResetHttpClientRetryMaxRetries No description.
ResetHttpClientRetryTimeout No description.
ResetValidate No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

ResetAlias 
private void ResetAlias()
ResetApiKey 
private void ResetApiKey()
ResetApiUrl 
private void ResetApiUrl()
ResetAppKey 
private void ResetAppKey()
ResetDefaultTags 
private void ResetDefaultTags()
ResetHttpClientRetryBackoffBase 
private void ResetHttpClientRetryBackoffBase()
ResetHttpClientRetryBackoffMultiplier 
private void ResetHttpClientRetryBackoffMultiplier()
ResetHttpClientRetryEnabled 
private void ResetHttpClientRetryEnabled()
ResetHttpClientRetryMaxRetries 
private void ResetHttpClientRetryMaxRetries()
ResetHttpClientRetryTimeout 
private void ResetHttpClientRetryTimeout()
ResetValidate 
private void ResetValidate()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformProvider No description.
GenerateConfigForImport Generates CDKTF code for importing a DatadogProvider resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Datadog;

DatadogProvider.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Datadog;

DatadogProvider.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformProvider 
using HashiCorp.Cdktf.Providers.Datadog;

DatadogProvider.IsTerraformProvider(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Datadog;

DatadogProvider.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a DatadogProvider resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the DatadogProvider to import.

ImportFromIdRequired
  • Type: string

The id of the existing DatadogProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the DatadogProvider to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
MetaAttributes System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource string No description.
Alias string No description.
AliasInput string No description.
ApiKeyInput string No description.
ApiUrlInput string No description.
AppKeyInput string No description.
DefaultTagsInput DatadogProviderDefaultTags No description.
HttpClientRetryBackoffBaseInput double No description.
HttpClientRetryBackoffMultiplierInput double No description.
HttpClientRetryEnabledInput string No description.
HttpClientRetryMaxRetriesInput double No description.
HttpClientRetryTimeoutInput double No description.
ValidateInput string No description.
ApiKey string No description.
ApiUrl string No description.
AppKey string No description.
DefaultTags DatadogProviderDefaultTags No description.
HttpClientRetryBackoffBase double No description.
HttpClientRetryBackoffMultiplier double No description.
HttpClientRetryEnabled string No description.
HttpClientRetryMaxRetries double No description.
HttpClientRetryTimeout double No description.
Validate string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
MetaAttributesRequired 
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
public string TerraformProviderSource { get; }
  • Type: string
AliasOptional 
public string Alias { get; }
  • Type: string
AliasInputOptional 
public string AliasInput { get; }
  • Type: string
ApiKeyInputOptional 
public string ApiKeyInput { get; }
  • Type: string
ApiUrlInputOptional 
public string ApiUrlInput { get; }
  • Type: string
AppKeyInputOptional 
public string AppKeyInput { get; }
  • Type: string
DefaultTagsInputOptional 
public DatadogProviderDefaultTags DefaultTagsInput { get; }
HttpClientRetryBackoffBaseInputOptional 
public double HttpClientRetryBackoffBaseInput { get; }
  • Type: double
HttpClientRetryBackoffMultiplierInputOptional 
public double HttpClientRetryBackoffMultiplierInput { get; }
  • Type: double
HttpClientRetryEnabledInputOptional 
public string HttpClientRetryEnabledInput { get; }
  • Type: string
HttpClientRetryMaxRetriesInputOptional 
public double HttpClientRetryMaxRetriesInput { get; }
  • Type: double
HttpClientRetryTimeoutInputOptional 
public double HttpClientRetryTimeoutInput { get; }
  • Type: double
ValidateInputOptional 
public string ValidateInput { get; }
  • Type: string
ApiKeyOptional 
public string ApiKey { get; }
  • Type: string
ApiUrlOptional 
public string ApiUrl { get; }
  • Type: string
AppKeyOptional 
public string AppKey { get; }
  • Type: string
DefaultTagsOptional 
public DatadogProviderDefaultTags DefaultTags { get; }
HttpClientRetryBackoffBaseOptional 
public double HttpClientRetryBackoffBase { get; }
  • Type: double
HttpClientRetryBackoffMultiplierOptional 
public double HttpClientRetryBackoffMultiplier { get; }
  • Type: double
HttpClientRetryEnabledOptional 
public string HttpClientRetryEnabled { get; }
  • Type: string
HttpClientRetryMaxRetriesOptional 
public double HttpClientRetryMaxRetries { get; }
  • Type: double
HttpClientRetryTimeoutOptional 
public double HttpClientRetryTimeout { get; }
  • Type: double
ValidateOptional 
public string Validate { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

DatadogProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Datadog;

new DatadogProviderConfig {
    string Alias = null,
    string ApiKey = null,
    string ApiUrl = null,
    string AppKey = null,
    DatadogProviderDefaultTags DefaultTags = null,
    double HttpClientRetryBackoffBase = null,
    double HttpClientRetryBackoffMultiplier = null,
    string HttpClientRetryEnabled = null,
    double HttpClientRetryMaxRetries = null,
    double HttpClientRetryTimeout = null,
    string Validate = null
};

Properties

Name Type Description
Alias string Alias name.
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.
AppKey string (Required unless validate is false) Datadog APP key. This can also be set via the DD_APP_KEY environment variable.
DefaultTags DatadogProviderDefaultTags default_tags block.
HttpClientRetryBackoffBase double The HTTP request retry back off base. Defaults to 2.
HttpClientRetryBackoffMultiplier double 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 double The HTTP request maximum retry number. Defaults to 3.
HttpClientRetryTimeout double The HTTP request retry timeout period. Defaults to 60 seconds.
Validate string Enables validation of the provided API key during provider initialization.
AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#alias DatadogProvider#alias}

ApiKeyOptional 
public string ApiKey { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#api_key DatadogProvider#api_key}

ApiUrlOptional 
public string ApiUrl { get; set; }
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#api_url DatadogProvider#api_url}

AppKeyOptional 
public string AppKey { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#app_key DatadogProvider#app_key}

DefaultTagsOptional 
public DatadogProviderDefaultTags DefaultTags { get; set; }

default_tags block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#default_tags DatadogProvider#default_tags}

HttpClientRetryBackoffBaseOptional 
public double HttpClientRetryBackoffBase { get; set; }
  • Type: double

The HTTP request retry back off base. Defaults to 2.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#http_client_retry_backoff_base DatadogProvider#http_client_retry_backoff_base}

HttpClientRetryBackoffMultiplierOptional 
public double HttpClientRetryBackoffMultiplier { get; set; }
  • Type: double

The HTTP request retry back off multiplier. Defaults to 2.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#http_client_retry_backoff_multiplier DatadogProvider#http_client_retry_backoff_multiplier}

HttpClientRetryEnabledOptional 
public string HttpClientRetryEnabled { get; set; }
  • Type: string

Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#http_client_retry_enabled DatadogProvider#http_client_retry_enabled}

HttpClientRetryMaxRetriesOptional 
public double HttpClientRetryMaxRetries { get; set; }
  • Type: double

The HTTP request maximum retry number. Defaults to 3.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#http_client_retry_max_retries DatadogProvider#http_client_retry_max_retries}

HttpClientRetryTimeoutOptional 
public double HttpClientRetryTimeout { get; set; }
  • Type: double

The HTTP request retry timeout period. Defaults to 60 seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#http_client_retry_timeout DatadogProvider#http_client_retry_timeout}

ValidateOptional 
public string Validate { get; set; }
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#validate DatadogProvider#validate}

DatadogProviderDefaultTags

Initializer 

using HashiCorp.Cdktf.Providers.Datadog;

new DatadogProviderDefaultTags {
    System.Collections.Generic.IDictionary<string, string> Tags = null
};

Properties

Name Type Description
Tags System.Collections.Generic.IDictionary<string, string> [Experimental - Monitors only] Resource tags to be applied by default across all resources.
TagsOptional 
public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

[Experimental - Monitors only] Resource tags to be applied by default across all resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs#tags DatadogProvider#tags}