Skip to content

Latest commit

 

History

History
1065 lines (669 loc) · 44.7 KB

provider.python.md

File metadata and controls

1065 lines (669 loc) · 44.7 KB
Raw

provider Submodule

Constructs

DatadogProvider

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

Initializers 

from cdktf_cdktf_provider_datadog import provider

provider.DatadogProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  api_key: str = None,
  api_url: str = None,
  app_key: str = None,
  default_tags: DatadogProviderDefaultTags = None,
  http_client_retry_backoff_base: typing.Union[int, float] = None,
  http_client_retry_backoff_multiplier: typing.Union[int, float] = None,
  http_client_retry_enabled: str = None,
  http_client_retry_max_retries: typing.Union[int, float] = None,
  http_client_retry_timeout: typing.Union[int, float] = None,
  validate: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
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.
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 DatadogProviderDefaultTags default_tags block.
http_client_retry_backoff_base typing.Union[int, float] The HTTP request retry back off base. Defaults to 2.
http_client_retry_backoff_multiplier typing.Union[int, float] 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 typing.Union[int, float] The HTTP request maximum retry number. Defaults to 3.
http_client_retry_timeout typing.Union[int, float] The HTTP request retry timeout period. Defaults to 60 seconds.
validate str Enables validation of the provided API key during provider initialization.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: str

Alias name.

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

api_keyOptional
  • Type: str

(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}

api_urlOptional
  • Type: 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.

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

app_keyOptional
  • Type: str

(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}

default_tagsOptional

default_tags block.

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

http_client_retry_backoff_baseOptional
  • Type: typing.Union[int, float]

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}

http_client_retry_backoff_multiplierOptional
  • Type: typing.Union[int, float]

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}

http_client_retry_enabledOptional
  • Type: str

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}

http_client_retry_max_retriesOptional
  • Type: typing.Union[int, float]

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}

http_client_retry_timeoutOptional
  • Type: typing.Union[int, float]

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
  • Type: 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.

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

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
reset_alias No description.
reset_api_key No description.
reset_api_url No description.
reset_app_key No description.
reset_default_tags No description.
reset_http_client_retry_backoff_base No description.
reset_http_client_retry_backoff_multiplier No description.
reset_http_client_retry_enabled No description.
reset_http_client_retry_max_retries No description.
reset_http_client_retry_timeout No description.
reset_validate No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

reset_alias 
def reset_alias() -> None
reset_api_key 
def reset_api_key() -> None
reset_api_url 
def reset_api_url() -> None
reset_app_key 
def reset_app_key() -> None
reset_default_tags 
def reset_default_tags() -> None
reset_http_client_retry_backoff_base 
def reset_http_client_retry_backoff_base() -> None
reset_http_client_retry_backoff_multiplier 
def reset_http_client_retry_backoff_multiplier() -> None
reset_http_client_retry_enabled 
def reset_http_client_retry_enabled() -> None
reset_http_client_retry_max_retries 
def reset_http_client_retry_max_retries() -> None
reset_http_client_retry_timeout 
def reset_http_client_retry_timeout() -> None
reset_validate 
def reset_validate() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_provider No description.
generate_config_for_import Generates CDKTF code for importing a DatadogProvider resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_datadog import provider

provider.DatadogProvider.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_datadog import provider

provider.DatadogProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktf_cdktf_provider_datadog import provider

provider.DatadogProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_datadog import provider

provider.DatadogProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
api_key_input str No description.
api_url_input str No description.
app_key_input str No description.
default_tags_input DatadogProviderDefaultTags No description.
http_client_retry_backoff_base_input typing.Union[int, float] No description.
http_client_retry_backoff_multiplier_input typing.Union[int, float] No description.
http_client_retry_enabled_input str No description.
http_client_retry_max_retries_input typing.Union[int, float] No description.
http_client_retry_timeout_input typing.Union[int, float] No description.
validate_input str No description.
api_key str No description.
api_url str No description.
app_key str No description.
default_tags DatadogProviderDefaultTags No description.
http_client_retry_backoff_base typing.Union[int, float] No description.
http_client_retry_backoff_multiplier typing.Union[int, float] No description.
http_client_retry_enabled str No description.
http_client_retry_max_retries typing.Union[int, float] No description.
http_client_retry_timeout typing.Union[int, float] No description.
validate str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
meta_attributesRequired 
meta_attributes: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
api_key_inputOptional 
api_key_input: str
  • Type: str
api_url_inputOptional 
api_url_input: str
  • Type: str
app_key_inputOptional 
app_key_input: str
  • Type: str
default_tags_inputOptional 
default_tags_input: DatadogProviderDefaultTags
http_client_retry_backoff_base_inputOptional 
http_client_retry_backoff_base_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_client_retry_backoff_multiplier_inputOptional 
http_client_retry_backoff_multiplier_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_client_retry_enabled_inputOptional 
http_client_retry_enabled_input: str
  • Type: str
http_client_retry_max_retries_inputOptional 
http_client_retry_max_retries_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_client_retry_timeout_inputOptional 
http_client_retry_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
validate_inputOptional 
validate_input: str
  • Type: str
api_keyOptional 
api_key: str
  • Type: str
api_urlOptional 
api_url: str
  • Type: str
app_keyOptional 
app_key: str
  • Type: str
default_tagsOptional 
default_tags: DatadogProviderDefaultTags
http_client_retry_backoff_baseOptional 
http_client_retry_backoff_base: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_client_retry_backoff_multiplierOptional 
http_client_retry_backoff_multiplier: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_client_retry_enabledOptional 
http_client_retry_enabled: str
  • Type: str
http_client_retry_max_retriesOptional 
http_client_retry_max_retries: typing.Union[int, float]
  • Type: typing.Union[int, float]
http_client_retry_timeoutOptional 
http_client_retry_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
validateOptional 
validate: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

DatadogProviderConfig

Initializer 

from cdktf_cdktf_provider_datadog import provider

provider.DatadogProviderConfig(
  alias: str = None,
  api_key: str = None,
  api_url: str = None,
  app_key: str = None,
  default_tags: DatadogProviderDefaultTags = None,
  http_client_retry_backoff_base: typing.Union[int, float] = None,
  http_client_retry_backoff_multiplier: typing.Union[int, float] = None,
  http_client_retry_enabled: str = None,
  http_client_retry_max_retries: typing.Union[int, float] = None,
  http_client_retry_timeout: typing.Union[int, float] = None,
  validate: str = None
)

Properties

Name Type Description
alias str Alias name.
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.
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 DatadogProviderDefaultTags default_tags block.
http_client_retry_backoff_base typing.Union[int, float] The HTTP request retry back off base. Defaults to 2.
http_client_retry_backoff_multiplier typing.Union[int, float] 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 typing.Union[int, float] The HTTP request maximum retry number. Defaults to 3.
http_client_retry_timeout typing.Union[int, float] The HTTP request retry timeout period. Defaults to 60 seconds.
validate str Enables validation of the provided API key during provider initialization.
aliasOptional 
alias: str
  • Type: str

Alias name.

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

api_keyOptional 
api_key: str
  • Type: str

(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}

api_urlOptional 
api_url: str
  • Type: 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.

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

app_keyOptional 
app_key: str
  • Type: str

(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}

default_tagsOptional 
default_tags: DatadogProviderDefaultTags

default_tags block.

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

http_client_retry_backoff_baseOptional 
http_client_retry_backoff_base: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

http_client_retry_backoff_multiplierOptional 
http_client_retry_backoff_multiplier: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

http_client_retry_enabledOptional 
http_client_retry_enabled: str
  • Type: str

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}

http_client_retry_max_retriesOptional 
http_client_retry_max_retries: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

http_client_retry_timeoutOptional 
http_client_retry_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

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 
validate: str
  • Type: 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.

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

DatadogProviderDefaultTags

Initializer 

from cdktf_cdktf_provider_datadog import provider

provider.DatadogProviderDefaultTags(
  tags: typing.Mapping[str] = None
)

Properties

Name Type Description
tags typing.Mapping[str] [Experimental - Monitors only] Resource tags to be applied by default across all resources.
tagsOptional 
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

[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}