dataCloudflareZoneSetting.typescript.md

dataCloudflareZoneSetting Submodule

Constructs

DataCloudflareZoneSetting

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/zone_setting cloudflare_zone_setting}.

Initializers

import { dataCloudflareZoneSetting } from '@cdktn/provider-cloudflare'

new dataCloudflareZoneSetting.DataCloudflareZoneSetting(scope: Construct, id: string, config: DataCloudflareZoneSettingConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataCloudflareZoneSettingConfig	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: DataCloudflareZoneSettingConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to 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.
resetZoneId	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: ...constructs.IMixin[]

The mixins to apply.

---

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

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}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetZoneId

public resetZoneId(): void

Static Functions

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

---

isConstruct

import { dataCloudflareZoneSetting } from '@cdktn/provider-cloudflare'

dataCloudflareZoneSetting.DataCloudflareZoneSetting.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 { dataCloudflareZoneSetting } from '@cdktn/provider-cloudflare'

dataCloudflareZoneSetting.DataCloudflareZoneSetting.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataCloudflareZoneSetting } from '@cdktn/provider-cloudflare'

dataCloudflareZoneSetting.DataCloudflareZoneSetting.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataCloudflareZoneSetting } from '@cdktn/provider-cloudflare'

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

Generates CDKTN code for importing a DataCloudflareZoneSetting resource upon running "cdktn 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 DataCloudflareZoneSetting to import.

---

importFromId^Required

• Type: string

The id of the existing DataCloudflareZoneSetting that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/zone_setting#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktn.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktn.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktn.TerraformProviderGeneratorMetadata	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
editable	cdktn.IResolvable	No description.
enabled	cdktn.IResolvable	No description.
id	string	No description.
modifiedOn	string	No description.
timeRemaining	number	No description.
value	string	No description.
settingIdInput	string	No description.
zoneIdInput	string	No description.
settingId	string	No description.
zoneId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktn.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

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

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktn.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

editable^Required

public readonly editable: IResolvable;

• Type: cdktn.IResolvable

---

enabled^Required

public readonly enabled: IResolvable;

• Type: cdktn.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

modifiedOn^Required

public readonly modifiedOn: string;

• Type: string

---

timeRemaining^Required

public readonly timeRemaining: number;

• Type: number

---

value^Required

public readonly value: string;

• Type: string

---

settingIdInput^Optional

public readonly settingIdInput: string;

• Type: string

---

zoneIdInput^Optional

public readonly zoneIdInput: string;

• Type: string

---

settingId^Required

public readonly settingId: string;

• Type: string

---

zoneId^Required

public readonly zoneId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataCloudflareZoneSettingConfig

Initializer

import { dataCloudflareZoneSetting } from '@cdktn/provider-cloudflare'

const dataCloudflareZoneSettingConfig: dataCloudflareZoneSetting.DataCloudflareZoneSettingConfig = { ... }

Properties

Name	Type	Description
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	cdktn.ITerraformDependable[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]	No description.
settingId	string	Setting name.
zoneId	string	Identifier.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktn.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

provisioners^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

• Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

---

settingId^Required

public readonly settingId: string;

• Type: string

Setting name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/zone_setting#setting_id DataCloudflareZoneSetting#setting_id}

---

zoneId^Optional

public readonly zoneId: string;

• Type: string

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/data-sources/zone_setting#zone_id DataCloudflareZoneSetting#zone_id}

---