Skip to content

Latest commit

 

History

History
917 lines (575 loc) · 36.2 KB

provider.go.md

File metadata and controls

917 lines (575 loc) · 36.2 KB

provider Submodule

Constructs

DatadogProvider

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

Initializers 

import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

provider.NewDatadogProvider(scope Construct, id *string, config DatadogProviderConfig) DatadogProvider
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DatadogProviderConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

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

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

ResetAlias 
func ResetAlias()
ResetApiKey 
func ResetApiKey()
ResetApiUrl 
func ResetApiUrl()
ResetAppKey 
func ResetAppKey()
ResetDefaultTags 
func ResetDefaultTags()
ResetHttpClientRetryBackoffBase 
func ResetHttpClientRetryBackoffBase()
ResetHttpClientRetryBackoffMultiplier 
func ResetHttpClientRetryBackoffMultiplier()
ResetHttpClientRetryEnabled 
func ResetHttpClientRetryEnabled()
ResetHttpClientRetryMaxRetries 
func ResetHttpClientRetryMaxRetries()
ResetHttpClientRetryTimeout 
func ResetHttpClientRetryTimeout()
ResetValidate 
func 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 "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

provider.DatadogProvider_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

provider.DatadogProvider_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformProvider 
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

provider.DatadogProvider_IsTerraformProvider(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

provider.DatadogProvider_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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.52.1/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
MetaAttributes *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/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 *f64 No description.
HttpClientRetryBackoffMultiplierInput *f64 No description.
HttpClientRetryEnabledInput *string No description.
HttpClientRetryMaxRetriesInput *f64 No description.
HttpClientRetryTimeoutInput *f64 No description.
ValidateInput *string No description.
ApiKey *string No description.
ApiUrl *string No description.
AppKey *string No description.
DefaultTags DatadogProviderDefaultTags No description.
HttpClientRetryBackoffBase *f64 No description.
HttpClientRetryBackoffMultiplier *f64 No description.
HttpClientRetryEnabled *string No description.
HttpClientRetryMaxRetries *f64 No description.
HttpClientRetryTimeout *f64 No description.
Validate *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
MetaAttributesRequired 
func MetaAttributes() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
func TerraformProviderSource() *string
  • Type: *string
AliasOptional 
func Alias() *string
  • Type: *string
AliasInputOptional 
func AliasInput() *string
  • Type: *string
ApiKeyInputOptional 
func ApiKeyInput() *string
  • Type: *string
ApiUrlInputOptional 
func ApiUrlInput() *string
  • Type: *string
AppKeyInputOptional 
func AppKeyInput() *string
  • Type: *string
DefaultTagsInputOptional 
func DefaultTagsInput() DatadogProviderDefaultTags
HttpClientRetryBackoffBaseInputOptional 
func HttpClientRetryBackoffBaseInput() *f64
  • Type: *f64
HttpClientRetryBackoffMultiplierInputOptional 
func HttpClientRetryBackoffMultiplierInput() *f64
  • Type: *f64
HttpClientRetryEnabledInputOptional 
func HttpClientRetryEnabledInput() *string
  • Type: *string
HttpClientRetryMaxRetriesInputOptional 
func HttpClientRetryMaxRetriesInput() *f64
  • Type: *f64
HttpClientRetryTimeoutInputOptional 
func HttpClientRetryTimeoutInput() *f64
  • Type: *f64
ValidateInputOptional 
func ValidateInput() *string
  • Type: *string
ApiKeyOptional 
func ApiKey() *string
  • Type: *string
ApiUrlOptional 
func ApiUrl() *string
  • Type: *string
AppKeyOptional 
func AppKey() *string
  • Type: *string
DefaultTagsOptional 
func DefaultTags() DatadogProviderDefaultTags
HttpClientRetryBackoffBaseOptional 
func HttpClientRetryBackoffBase() *f64
  • Type: *f64
HttpClientRetryBackoffMultiplierOptional 
func HttpClientRetryBackoffMultiplier() *f64
  • Type: *f64
HttpClientRetryEnabledOptional 
func HttpClientRetryEnabled() *string
  • Type: *string
HttpClientRetryMaxRetriesOptional 
func HttpClientRetryMaxRetries() *f64
  • Type: *f64
HttpClientRetryTimeoutOptional 
func HttpClientRetryTimeout() *f64
  • Type: *f64
ValidateOptional 
func Validate() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

DatadogProviderConfig

Initializer 

import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

&provider.DatadogProviderConfig {
	Alias: *string,
	ApiKey: *string,
	ApiUrl: *string,
	AppKey: *string,
	DefaultTags: github.com/cdktf/cdktf-provider-datadog-go/datadog/v11.provider.DatadogProviderDefaultTags,
	HttpClientRetryBackoffBase: *f64,
	HttpClientRetryBackoffMultiplier: *f64,
	HttpClientRetryEnabled: *string,
	HttpClientRetryMaxRetries: *f64,
	HttpClientRetryTimeout: *f64,
	Validate: *string,
}

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 *f64 The HTTP request retry back off base. Defaults to 2.
HttpClientRetryBackoffMultiplier *f64 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 *f64 The HTTP request maximum retry number. Defaults to 3.
HttpClientRetryTimeout *f64 The HTTP request retry timeout period. Defaults to 60 seconds.
Validate *string Enables validation of the provided API key during provider initialization.
AliasOptional 
Alias *string
  • Type: *string

Alias name.

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

ApiKeyOptional 
ApiKey *string
  • 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.52.1/docs#api_key DatadogProvider#api_key}

ApiUrlOptional 
ApiUrl *string
  • 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.52.1/docs#api_url DatadogProvider#api_url}

AppKeyOptional 
AppKey *string
  • 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.52.1/docs#app_key DatadogProvider#app_key}

DefaultTagsOptional 
DefaultTags DatadogProviderDefaultTags

default_tags block.

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

HttpClientRetryBackoffBaseOptional 
HttpClientRetryBackoffBase *f64
  • Type: *f64

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

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

HttpClientRetryBackoffMultiplierOptional 
HttpClientRetryBackoffMultiplier *f64
  • Type: *f64

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

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

HttpClientRetryEnabledOptional 
HttpClientRetryEnabled *string
  • 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.52.1/docs#http_client_retry_enabled DatadogProvider#http_client_retry_enabled}

HttpClientRetryMaxRetriesOptional 
HttpClientRetryMaxRetries *f64
  • Type: *f64

The HTTP request maximum retry number. Defaults to 3.

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

HttpClientRetryTimeoutOptional 
HttpClientRetryTimeout *f64
  • Type: *f64

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

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

ValidateOptional 
Validate *string
  • 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.52.1/docs#validate DatadogProvider#validate}

DatadogProviderDefaultTags

Initializer 

import "github.com/cdktf/cdktf-provider-datadog-go/datadog/v11/provider"

&provider.DatadogProviderDefaultTags {
	Tags: *map[string]*string,
}

Properties

Name Type Description
Tags *map[string]*string [Experimental - Monitors only] Resource tags to be applied by default across all resources.
TagsOptional 
Tags *map[string]*string
  • Type: *map[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.52.1/docs#tags DatadogProvider#tags}