Skip to content

Latest commit

 

History

History
1047 lines (651 loc) · 45.8 KB

provider.java.md

File metadata and controls

1047 lines (651 loc) · 45.8 KB

provider Submodule

Constructs

DatadogProvider

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

Initializers 

import com.hashicorp.cdktf.providers.datadog.provider.DatadogProvider;

DatadogProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .apiKey(java.lang.String)
//  .apiUrl(java.lang.String)
//  .appKey(java.lang.String)
//  .defaultTags(DatadogProviderDefaultTags)
//  .httpClientRetryBackoffBase(java.lang.Number)
//  .httpClientRetryBackoffMultiplier(java.lang.Number)
//  .httpClientRetryEnabled(java.lang.String)
//  .httpClientRetryMaxRetries(java.lang.Number)
//  .httpClientRetryTimeout(java.lang.Number)
//  .validate(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
alias java.lang.String Alias name.
apiKey java.lang.String (Required unless validate is false) Datadog API key. This can also be set via the DD_API_KEY environment variable.
apiUrl java.lang.String The API URL.
appKey java.lang.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 java.lang.Number The HTTP request retry back off base. Defaults to 2.
httpClientRetryBackoffMultiplier java.lang.Number The HTTP request retry back off multiplier. Defaults to 2.
httpClientRetryEnabled java.lang.String Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
httpClientRetryMaxRetries java.lang.Number The HTTP request maximum retry number. Defaults to 3.
httpClientRetryTimeout java.lang.Number The HTTP request retry timeout period. Defaults to 60 seconds.
validate java.lang.String Enables validation of the provided API key during provider initialization.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: java.lang.String

Alias name.

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

apiKeyOptional
  • Type: java.lang.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.57.0/docs#api_key DatadogProvider#api_key}

apiUrlOptional
  • Type: java.lang.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.57.0/docs#api_url DatadogProvider#api_url}

appKeyOptional
  • Type: java.lang.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.57.0/docs#app_key DatadogProvider#app_key}

defaultTagsOptional

default_tags block.

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

httpClientRetryBackoffBaseOptional
  • Type: java.lang.Number

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

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

httpClientRetryBackoffMultiplierOptional
  • Type: java.lang.Number

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

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

httpClientRetryEnabledOptional
  • Type: java.lang.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.57.0/docs#http_client_retry_enabled DatadogProvider#http_client_retry_enabled}

httpClientRetryMaxRetriesOptional
  • Type: java.lang.Number

The HTTP request maximum retry number. Defaults to 3.

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

httpClientRetryTimeoutOptional
  • Type: java.lang.Number

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

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

validateOptional
  • Type: java.lang.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.57.0/docs#validate DatadogProvider#validate}

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 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

resetAlias 
public void resetAlias()
resetApiKey 
public void resetApiKey()
resetApiUrl 
public void resetApiUrl()
resetAppKey 
public void resetAppKey()
resetDefaultTags 
public void resetDefaultTags()
resetHttpClientRetryBackoffBase 
public void resetHttpClientRetryBackoffBase()
resetHttpClientRetryBackoffMultiplier 
public void resetHttpClientRetryBackoffMultiplier()
resetHttpClientRetryEnabled 
public void resetHttpClientRetryEnabled()
resetHttpClientRetryMaxRetries 
public void resetHttpClientRetryMaxRetries()
resetHttpClientRetryTimeout 
public void resetHttpClientRetryTimeout()
resetValidate 
public 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 
import com.hashicorp.cdktf.providers.datadog.provider.DatadogProvider;

DatadogProvider.isConstruct(java.lang.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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.datadog.provider.DatadogProvider;

DatadogProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.datadog.provider.DatadogProvider;

DatadogProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.datadog.provider.DatadogProvider;

DatadogProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DatadogProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing DatadogProvider that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
aliasInput java.lang.String No description.
apiKeyInput java.lang.String No description.
apiUrlInput java.lang.String No description.
appKeyInput java.lang.String No description.
defaultTagsInput DatadogProviderDefaultTags No description.
httpClientRetryBackoffBaseInput java.lang.Number No description.
httpClientRetryBackoffMultiplierInput java.lang.Number No description.
httpClientRetryEnabledInput java.lang.String No description.
httpClientRetryMaxRetriesInput java.lang.Number No description.
httpClientRetryTimeoutInput java.lang.Number No description.
validateInput java.lang.String No description.
apiKey java.lang.String No description.
apiUrl java.lang.String No description.
appKey java.lang.String No description.
defaultTags DatadogProviderDefaultTags No description.
httpClientRetryBackoffBase java.lang.Number No description.
httpClientRetryBackoffMultiplier java.lang.Number No description.
httpClientRetryEnabled java.lang.String No description.
httpClientRetryMaxRetries java.lang.Number No description.
httpClientRetryTimeout java.lang.Number No description.
validate java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
apiKeyInputOptional 
public java.lang.String getApiKeyInput();
  • Type: java.lang.String
apiUrlInputOptional 
public java.lang.String getApiUrlInput();
  • Type: java.lang.String
appKeyInputOptional 
public java.lang.String getAppKeyInput();
  • Type: java.lang.String
defaultTagsInputOptional 
public DatadogProviderDefaultTags getDefaultTagsInput();
httpClientRetryBackoffBaseInputOptional 
public java.lang.Number getHttpClientRetryBackoffBaseInput();
  • Type: java.lang.Number
httpClientRetryBackoffMultiplierInputOptional 
public java.lang.Number getHttpClientRetryBackoffMultiplierInput();
  • Type: java.lang.Number
httpClientRetryEnabledInputOptional 
public java.lang.String getHttpClientRetryEnabledInput();
  • Type: java.lang.String
httpClientRetryMaxRetriesInputOptional 
public java.lang.Number getHttpClientRetryMaxRetriesInput();
  • Type: java.lang.Number
httpClientRetryTimeoutInputOptional 
public java.lang.Number getHttpClientRetryTimeoutInput();
  • Type: java.lang.Number
validateInputOptional 
public java.lang.String getValidateInput();
  • Type: java.lang.String
apiKeyOptional 
public java.lang.String getApiKey();
  • Type: java.lang.String
apiUrlOptional 
public java.lang.String getApiUrl();
  • Type: java.lang.String
appKeyOptional 
public java.lang.String getAppKey();
  • Type: java.lang.String
defaultTagsOptional 
public DatadogProviderDefaultTags getDefaultTags();
httpClientRetryBackoffBaseOptional 
public java.lang.Number getHttpClientRetryBackoffBase();
  • Type: java.lang.Number
httpClientRetryBackoffMultiplierOptional 
public java.lang.Number getHttpClientRetryBackoffMultiplier();
  • Type: java.lang.Number
httpClientRetryEnabledOptional 
public java.lang.String getHttpClientRetryEnabled();
  • Type: java.lang.String
httpClientRetryMaxRetriesOptional 
public java.lang.Number getHttpClientRetryMaxRetries();
  • Type: java.lang.Number
httpClientRetryTimeoutOptional 
public java.lang.Number getHttpClientRetryTimeout();
  • Type: java.lang.Number
validateOptional 
public java.lang.String getValidate();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DatadogProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.datadog.provider.DatadogProviderConfig;

DatadogProviderConfig.builder()
//  .alias(java.lang.String)
//  .apiKey(java.lang.String)
//  .apiUrl(java.lang.String)
//  .appKey(java.lang.String)
//  .defaultTags(DatadogProviderDefaultTags)
//  .httpClientRetryBackoffBase(java.lang.Number)
//  .httpClientRetryBackoffMultiplier(java.lang.Number)
//  .httpClientRetryEnabled(java.lang.String)
//  .httpClientRetryMaxRetries(java.lang.Number)
//  .httpClientRetryTimeout(java.lang.Number)
//  .validate(java.lang.String)
    .build();

Properties

Name Type Description
alias java.lang.String Alias name.
apiKey java.lang.String (Required unless validate is false) Datadog API key. This can also be set via the DD_API_KEY environment variable.
apiUrl java.lang.String The API URL.
appKey java.lang.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 java.lang.Number The HTTP request retry back off base. Defaults to 2.
httpClientRetryBackoffMultiplier java.lang.Number The HTTP request retry back off multiplier. Defaults to 2.
httpClientRetryEnabled java.lang.String Enables request retries on HTTP status codes 429 and 5xx. Valid values are [true, false]. Defaults to true.
httpClientRetryMaxRetries java.lang.Number The HTTP request maximum retry number. Defaults to 3.
httpClientRetryTimeout java.lang.Number The HTTP request retry timeout period. Defaults to 60 seconds.
validate java.lang.String Enables validation of the provided API key during provider initialization.
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

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

apiKeyOptional 
public java.lang.String getApiKey();
  • Type: java.lang.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.57.0/docs#api_key DatadogProvider#api_key}

apiUrlOptional 
public java.lang.String getApiUrl();
  • Type: java.lang.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.57.0/docs#api_url DatadogProvider#api_url}

appKeyOptional 
public java.lang.String getAppKey();
  • Type: java.lang.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.57.0/docs#app_key DatadogProvider#app_key}

defaultTagsOptional 
public DatadogProviderDefaultTags getDefaultTags();

default_tags block.

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

httpClientRetryBackoffBaseOptional 
public java.lang.Number getHttpClientRetryBackoffBase();
  • Type: java.lang.Number

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

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

httpClientRetryBackoffMultiplierOptional 
public java.lang.Number getHttpClientRetryBackoffMultiplier();
  • Type: java.lang.Number

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

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

httpClientRetryEnabledOptional 
public java.lang.String getHttpClientRetryEnabled();
  • Type: java.lang.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.57.0/docs#http_client_retry_enabled DatadogProvider#http_client_retry_enabled}

httpClientRetryMaxRetriesOptional 
public java.lang.Number getHttpClientRetryMaxRetries();
  • Type: java.lang.Number

The HTTP request maximum retry number. Defaults to 3.

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

httpClientRetryTimeoutOptional 
public java.lang.Number getHttpClientRetryTimeout();
  • Type: java.lang.Number

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

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

validateOptional 
public java.lang.String getValidate();
  • Type: java.lang.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.57.0/docs#validate DatadogProvider#validate}

DatadogProviderDefaultTags

Initializer 

import com.hashicorp.cdktf.providers.datadog.provider.DatadogProviderDefaultTags;

DatadogProviderDefaultTags.builder()
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
tags java.util.Map<java.lang.String, java.lang.String> [Experimental - Monitors and Logs Pipelines only] Resource tags to be applied by default across all resources.
tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>

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

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