Skip to content

Latest commit

 

History

History
991 lines (616 loc) · 49.8 KB

dataNewrelicServiceLevelAlertHelper.typescript.md

File metadata and controls

991 lines (616 loc) · 49.8 KB

dataNewrelicServiceLevelAlertHelper Submodule

Constructs

DataNewrelicServiceLevelAlertHelper

Represents a {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper newrelic_service_level_alert_helper}.

Initializers

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

new dataNewrelicServiceLevelAlertHelper.DataNewrelicServiceLevelAlertHelper(scope: Construct, id: string, config: DataNewrelicServiceLevelAlertHelperConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataNewrelicServiceLevelAlertHelperConfig 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


configRequired

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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resetCustomEvaluationPeriod No description.
resetCustomToleratedBudgetConsumption No description.
resetId No description.
resetIsBadEvents No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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

Adds this resource to the terraform JSON output.

toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

resetCustomEvaluationPeriod
public resetCustomEvaluationPeriod(): void
resetCustomToleratedBudgetConsumption
public resetCustomToleratedBudgetConsumption(): void
resetId
public resetId(): void
resetIsBadEvents
public resetIsBadEvents(): void

Static Functions

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

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

dataNewrelicServiceLevelAlertHelper.DataNewrelicServiceLevelAlertHelper.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.

xRequired
  • Type: any

Any object.


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

dataNewrelicServiceLevelAlertHelper.DataNewrelicServiceLevelAlertHelper.isTerraformElement(x: any)
xRequired
  • Type: any

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

dataNewrelicServiceLevelAlertHelper.DataNewrelicServiceLevelAlertHelper.isTerraformDataSource(x: any)
xRequired
  • Type: any

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

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

Generates CDKTF code for importing a DataNewrelicServiceLevelAlertHelper 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 DataNewrelicServiceLevelAlertHelper to import.


importFromIdRequired
  • Type: string

The id of the existing DataNewrelicServiceLevelAlertHelper that should be imported.

Refer to the {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#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 DataNewrelicServiceLevelAlertHelper 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.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
evaluationPeriod number No description.
nrql string No description.
threshold number No description.
toleratedBudgetConsumption number No description.
alertTypeInput string No description.
customEvaluationPeriodInput number No description.
customToleratedBudgetConsumptionInput number No description.
idInput string No description.
isBadEventsInput boolean | cdktf.IResolvable No description.
sliGuidInput string No description.
sloPeriodInput number No description.
sloTargetInput number No description.
alertType string No description.
customEvaluationPeriod number No description.
customToleratedBudgetConsumption number No description.
id string No description.
isBadEvents boolean | cdktf.IResolvable No description.
sliGuid string No description.
sloPeriod number No description.
sloTarget number No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

evaluationPeriodRequired
public readonly evaluationPeriod: number;
  • Type: number

nrqlRequired
public readonly nrql: string;
  • Type: string

thresholdRequired
public readonly threshold: number;
  • Type: number

toleratedBudgetConsumptionRequired
public readonly toleratedBudgetConsumption: number;
  • Type: number

alertTypeInputOptional
public readonly alertTypeInput: string;
  • Type: string

customEvaluationPeriodInputOptional
public readonly customEvaluationPeriodInput: number;
  • Type: number

customToleratedBudgetConsumptionInputOptional
public readonly customToleratedBudgetConsumptionInput: number;
  • Type: number

idInputOptional
public readonly idInput: string;
  • Type: string

isBadEventsInputOptional
public readonly isBadEventsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

sliGuidInputOptional
public readonly sliGuidInput: string;
  • Type: string

sloPeriodInputOptional
public readonly sloPeriodInput: number;
  • Type: number

sloTargetInputOptional
public readonly sloTargetInput: number;
  • Type: number

alertTypeRequired
public readonly alertType: string;
  • Type: string

customEvaluationPeriodRequired
public readonly customEvaluationPeriod: number;
  • Type: number

customToleratedBudgetConsumptionRequired
public readonly customToleratedBudgetConsumption: number;
  • Type: number

idRequired
public readonly id: string;
  • Type: string

isBadEventsRequired
public readonly isBadEvents: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

sliGuidRequired
public readonly sliGuid: string;
  • Type: string

sloPeriodRequired
public readonly sloPeriod: number;
  • Type: number

sloTargetRequired
public readonly sloTarget: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataNewrelicServiceLevelAlertHelperConfig

Initializer

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

const dataNewrelicServiceLevelAlertHelperConfig: dataNewrelicServiceLevelAlertHelper.DataNewrelicServiceLevelAlertHelperConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
alertType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#alert_type DataNewrelicServiceLevelAlertHelper#alert_type}.
sliGuid string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#sli_guid DataNewrelicServiceLevelAlertHelper#sli_guid}.
sloPeriod number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#slo_period DataNewrelicServiceLevelAlertHelper#slo_period}.
sloTarget number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#slo_target DataNewrelicServiceLevelAlertHelper#slo_target}.
customEvaluationPeriod number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#custom_evaluation_period DataNewrelicServiceLevelAlertHelper#custom_evaluation_period}.
customToleratedBudgetConsumption number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#custom_tolerated_budget_consumption DataNewrelicServiceLevelAlertHelper#custom_tolerated_budget_consumption}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#id DataNewrelicServiceLevelAlertHelper#id}.
isBadEvents boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#is_bad_events DataNewrelicServiceLevelAlertHelper#is_bad_events}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

alertTypeRequired
public readonly alertType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#alert_type DataNewrelicServiceLevelAlertHelper#alert_type}.


sliGuidRequired
public readonly sliGuid: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#sli_guid DataNewrelicServiceLevelAlertHelper#sli_guid}.


sloPeriodRequired
public readonly sloPeriod: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#slo_period DataNewrelicServiceLevelAlertHelper#slo_period}.


sloTargetRequired
public readonly sloTarget: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#slo_target DataNewrelicServiceLevelAlertHelper#slo_target}.


customEvaluationPeriodOptional
public readonly customEvaluationPeriod: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#custom_evaluation_period DataNewrelicServiceLevelAlertHelper#custom_evaluation_period}.


customToleratedBudgetConsumptionOptional
public readonly customToleratedBudgetConsumption: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#custom_tolerated_budget_consumption DataNewrelicServiceLevelAlertHelper#custom_tolerated_budget_consumption}.


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#id DataNewrelicServiceLevelAlertHelper#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


isBadEventsOptional
public readonly isBadEvents: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.56.0/docs/data-sources/service_level_alert_helper#is_bad_events DataNewrelicServiceLevelAlertHelper#is_bad_events}.