provider.typescript.md

provider Submodule

Constructs

NewrelicProvider

Represents a {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs newrelic}.

Initializers

import { provider } from '@cdktf/provider-newrelic'

new provider.NewrelicProvider(scope: Construct, id: string, config: NewrelicProviderConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	NewrelicProviderConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: NewrelicProviderConfig

---

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.
resetAdminApiKey	No description.
resetAlias	No description.
resetApiUrl	No description.
resetCacertFile	No description.
resetInfrastructureApiUrl	No description.
resetInsecureSkipVerify	No description.
resetInsightsInsertKey	No description.
resetInsightsInsertUrl	No description.
resetInsightsQueryUrl	No description.
resetNerdgraphApiUrl	No description.
resetRegion	No description.
resetSyntheticsApiUrl	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

resetAdminApiKey

public resetAdminApiKey(): void

resetAlias

public resetAlias(): void

resetApiUrl

public resetApiUrl(): void

resetCacertFile

public resetCacertFile(): void

resetInfrastructureApiUrl

public resetInfrastructureApiUrl(): void

resetInsecureSkipVerify

public resetInsecureSkipVerify(): void

resetInsightsInsertKey

public resetInsightsInsertKey(): void

resetInsightsInsertUrl

public resetInsightsInsertUrl(): void

resetInsightsQueryUrl

public resetInsightsQueryUrl(): void

resetNerdgraphApiUrl

public resetNerdgraphApiUrl(): void

resetRegion

public resetRegion(): void

resetSyntheticsApiUrl

public resetSyntheticsApiUrl(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformProvider	No description.
generateConfigForImport	Generates CDKTF code for importing a NewrelicProvider resource upon running "cdktf plan ".

---

isConstruct

import { provider } from '@cdktf/provider-newrelic'

provider.NewrelicProvider.isConstruct(x: 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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { provider } from '@cdktf/provider-newrelic'

provider.NewrelicProvider.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformProvider

import { provider } from '@cdktf/provider-newrelic'

provider.NewrelicProvider.isTerraformProvider(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { provider } from '@cdktf/provider-newrelic'

provider.NewrelicProvider.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing NewrelicProvider that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
metaAttributes	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
terraformProviderSource	string	No description.
alias	string	No description.
accountIdInput	number	No description.
adminApiKeyInput	string	No description.
aliasInput	string	No description.
apiKeyInput	string	No description.
apiUrlInput	string	No description.
cacertFileInput	string	No description.
infrastructureApiUrlInput	string	No description.
insecureSkipVerifyInput	boolean | cdktf.IResolvable	No description.
insightsInsertKeyInput	string	No description.
insightsInsertUrlInput	string	No description.
insightsQueryUrlInput	string	No description.
nerdgraphApiUrlInput	string	No description.
regionInput	string	No description.
syntheticsApiUrlInput	string	No description.
accountId	number	No description.
adminApiKey	string	No description.
apiKey	string	No description.
apiUrl	string	No description.
cacertFile	string	No description.
infrastructureApiUrl	string	No description.
insecureSkipVerify	boolean | cdktf.IResolvable	No description.
insightsInsertKey	string	No description.
insightsInsertUrl	string	No description.
insightsQueryUrl	string	No description.
nerdgraphApiUrl	string	No description.
region	string	No description.
syntheticsApiUrl	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

metaAttributes^Required

public readonly metaAttributes: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

terraformProviderSource^Optional

public readonly terraformProviderSource: string;

• Type: string

---

alias^Optional

public readonly alias: string;

• Type: string

---

accountIdInput^Optional

public readonly accountIdInput: number;

• Type: number

---

adminApiKeyInput^Optional

public readonly adminApiKeyInput: string;

• Type: string

---

aliasInput^Optional

public readonly aliasInput: string;

• Type: string

---

apiKeyInput^Optional

public readonly apiKeyInput: string;

• Type: string

---

apiUrlInput^Optional

public readonly apiUrlInput: string;

• Type: string

---

cacertFileInput^Optional

public readonly cacertFileInput: string;

• Type: string

---

infrastructureApiUrlInput^Optional

public readonly infrastructureApiUrlInput: string;

• Type: string

---

insecureSkipVerifyInput^Optional

public readonly insecureSkipVerifyInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

insightsInsertKeyInput^Optional

public readonly insightsInsertKeyInput: string;

• Type: string

---

insightsInsertUrlInput^Optional

public readonly insightsInsertUrlInput: string;

• Type: string

---

insightsQueryUrlInput^Optional

public readonly insightsQueryUrlInput: string;

• Type: string

---

nerdgraphApiUrlInput^Optional

public readonly nerdgraphApiUrlInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

syntheticsApiUrlInput^Optional

public readonly syntheticsApiUrlInput: string;

• Type: string

---

accountId^Optional

public readonly accountId: number;

• Type: number

---

adminApiKey^Optional

public readonly adminApiKey: string;

• Type: string

---

apiKey^Optional

public readonly apiKey: string;

• Type: string

---

apiUrl^Optional

public readonly apiUrl: string;

• Type: string

---

cacertFile^Optional

public readonly cacertFile: string;

• Type: string

---

infrastructureApiUrl^Optional

public readonly infrastructureApiUrl: string;

• Type: string

---

insecureSkipVerify^Optional

public readonly insecureSkipVerify: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

insightsInsertKey^Optional

public readonly insightsInsertKey: string;

• Type: string

---

insightsInsertUrl^Optional

public readonly insightsInsertUrl: string;

• Type: string

---

insightsQueryUrl^Optional

public readonly insightsQueryUrl: string;

• Type: string

---

nerdgraphApiUrl^Optional

public readonly nerdgraphApiUrl: string;

• Type: string

---

region^Optional

public readonly region: string;

• Type: string

---

syntheticsApiUrl^Optional

public readonly syntheticsApiUrl: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

NewrelicProviderConfig

Initializer

import { provider } from '@cdktf/provider-newrelic'

const newrelicProviderConfig: provider.NewrelicProviderConfig = { ... }

Properties

Name	Type	Description
accountId	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#account_id NewrelicProvider#account_id}.
apiKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#api_key NewrelicProvider#api_key}.
adminApiKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#admin_api_key NewrelicProvider#admin_api_key}.
alias	string	Alias name.
apiUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#api_url NewrelicProvider#api_url}.
cacertFile	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#cacert_file NewrelicProvider#cacert_file}.
infrastructureApiUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#infrastructure_api_url NewrelicProvider#infrastructure_api_url}.
insecureSkipVerify	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insecure_skip_verify NewrelicProvider#insecure_skip_verify}.
insightsInsertKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insights_insert_key NewrelicProvider#insights_insert_key}.
insightsInsertUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insights_insert_url NewrelicProvider#insights_insert_url}.
insightsQueryUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insights_query_url NewrelicProvider#insights_query_url}.
nerdgraphApiUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#nerdgraph_api_url NewrelicProvider#nerdgraph_api_url}.
region	string	The data center for which your New Relic account is configured. Only one region per provider block is permitted.
syntheticsApiUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#synthetics_api_url NewrelicProvider#synthetics_api_url}.

---

accountId^Required

public readonly accountId: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#account_id NewrelicProvider#account_id}.

---

apiKey^Required

public readonly apiKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#api_key NewrelicProvider#api_key}.

---

adminApiKey^Optional

public readonly adminApiKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#admin_api_key NewrelicProvider#admin_api_key}.

---

alias^Optional

public readonly alias: string;

• Type: string

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#alias NewrelicProvider#alias}

---

apiUrl^Optional

public readonly apiUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#api_url NewrelicProvider#api_url}.

---

cacertFile^Optional

public readonly cacertFile: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#cacert_file NewrelicProvider#cacert_file}.

---

infrastructureApiUrl^Optional

public readonly infrastructureApiUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#infrastructure_api_url NewrelicProvider#infrastructure_api_url}.

---

insecureSkipVerify^Optional

public readonly insecureSkipVerify: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insecure_skip_verify NewrelicProvider#insecure_skip_verify}.

---

insightsInsertKey^Optional

public readonly insightsInsertKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insights_insert_key NewrelicProvider#insights_insert_key}.

---

insightsInsertUrl^Optional

public readonly insightsInsertUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insights_insert_url NewrelicProvider#insights_insert_url}.

---

insightsQueryUrl^Optional

public readonly insightsQueryUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#insights_query_url NewrelicProvider#insights_query_url}.

---

nerdgraphApiUrl^Optional

public readonly nerdgraphApiUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#nerdgraph_api_url NewrelicProvider#nerdgraph_api_url}.

---

region^Optional

public readonly region: string;

• Type: string

The data center for which your New Relic account is configured. Only one region per provider block is permitted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#region NewrelicProvider#region}

---

syntheticsApiUrl^Optional

public readonly syntheticsApiUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs#synthetics_api_url NewrelicProvider#synthetics_api_url}.

---