zoneCacheVariants.typescript.md

zoneCacheVariants Submodule

Constructs

ZoneCacheVariants

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants cloudflare_zone_cache_variants}.

Initializers

import { zoneCacheVariants } from '@cdktf/provider-cloudflare'

new zoneCacheVariants.ZoneCacheVariants(scope: Construct, id: string, config: ZoneCacheVariantsConfig)

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

---

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.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
resetAvif	No description.
resetBmp	No description.
resetGif	No description.
resetId	No description.
resetJp2	No description.
resetJpeg	No description.
resetJpg	No description.
resetJpg2	No description.
resetPng	No description.
resetTif	No description.
resetTiff	No description.
resetWebp	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.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

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

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

resetAvif

public resetAvif(): void

resetBmp

public resetBmp(): void

resetGif

public resetGif(): void

resetId

public resetId(): void

resetJp2

public resetJp2(): void

resetJpeg

public resetJpeg(): void

resetJpg

public resetJpg(): void

resetJpg2

public resetJpg2(): void

resetPng

public resetPng(): void

resetTif

public resetTif(): void

resetTiff

public resetTiff(): void

resetWebp

public resetWebp(): void

Static Functions

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

---

isConstruct

import { zoneCacheVariants } from '@cdktf/provider-cloudflare'

zoneCacheVariants.ZoneCacheVariants.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 { zoneCacheVariants } from '@cdktf/provider-cloudflare'

zoneCacheVariants.ZoneCacheVariants.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { zoneCacheVariants } from '@cdktf/provider-cloudflare'

zoneCacheVariants.ZoneCacheVariants.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { zoneCacheVariants } from '@cdktf/provider-cloudflare'

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

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

---

importFromId^Required

• Type: string

The id of the existing ZoneCacheVariants that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#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 ZoneCacheVariants 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.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	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.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
avifInput	string[]	No description.
bmpInput	string[]	No description.
gifInput	string[]	No description.
idInput	string	No description.
jp2Input	string[]	No description.
jpegInput	string[]	No description.
jpg2Input	string[]	No description.
jpgInput	string[]	No description.
pngInput	string[]	No description.
tiffInput	string[]	No description.
tifInput	string[]	No description.
webpInput	string[]	No description.
zoneIdInput	string	No description.
avif	string[]	No description.
bmp	string[]	No description.
gif	string[]	No description.
id	string	No description.
jp2	string[]	No description.
jpeg	string[]	No description.
jpg	string[]	No description.
jpg2	string[]	No description.
png	string[]	No description.
tif	string[]	No description.
tiff	string[]	No description.
webp	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: cdktf.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: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

avifInput^Optional

public readonly avifInput: string[];

• Type: string[]

---

bmpInput^Optional

public readonly bmpInput: string[];

• Type: string[]

---

gifInput^Optional

public readonly gifInput: string[];

• Type: string[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

jp2Input^Optional

public readonly jp2Input: string[];

• Type: string[]

---

jpegInput^Optional

public readonly jpegInput: string[];

• Type: string[]

---

jpg2Input^Optional

public readonly jpg2Input: string[];

• Type: string[]

---

jpgInput^Optional

public readonly jpgInput: string[];

• Type: string[]

---

pngInput^Optional

public readonly pngInput: string[];

• Type: string[]

---

tiffInput^Optional

public readonly tiffInput: string[];

• Type: string[]

---

tifInput^Optional

public readonly tifInput: string[];

• Type: string[]

---

webpInput^Optional

public readonly webpInput: string[];

• Type: string[]

---

zoneIdInput^Optional

public readonly zoneIdInput: string;

• Type: string

---

avif^Required

public readonly avif: string[];

• Type: string[]

---

bmp^Required

public readonly bmp: string[];

• Type: string[]

---

gif^Required

public readonly gif: string[];

• Type: string[]

---

id^Required

public readonly id: string;

• Type: string

---

jp2^Required

public readonly jp2: string[];

• Type: string[]

---

jpeg^Required

public readonly jpeg: string[];

• Type: string[]

---

jpg^Required

public readonly jpg: string[];

• Type: string[]

---

jpg2^Required

public readonly jpg2: string[];

• Type: string[]

---

png^Required

public readonly png: string[];

• Type: string[]

---

tif^Required

public readonly tif: string[];

• Type: string[]

---

tiff^Required

public readonly tiff: string[];

• Type: string[]

---

webp^Required

public readonly webp: 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

ZoneCacheVariantsConfig

Initializer

import { zoneCacheVariants } from '@cdktf/provider-cloudflare'

const zoneCacheVariantsConfig: zoneCacheVariants.ZoneCacheVariantsConfig = { ... }

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.
zoneId	string	The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..
avif	string[]	List of strings with the MIME types of all the variants that should be served for avif.
bmp	string[]	List of strings with the MIME types of all the variants that should be served for bmp.
gif	string[]	List of strings with the MIME types of all the variants that should be served for gif.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#id ZoneCacheVariants#id}.
jp2	string[]	List of strings with the MIME types of all the variants that should be served for jp2.
jpeg	string[]	List of strings with the MIME types of all the variants that should be served for jpeg.
jpg	string[]	List of strings with the MIME types of all the variants that should be served for jpg.
jpg2	string[]	List of strings with the MIME types of all the variants that should be served for jpg2.
png	string[]	List of strings with the MIME types of all the variants that should be served for png.
tif	string[]	List of strings with the MIME types of all the variants that should be served for tif.
tiff	string[]	List of strings with the MIME types of all the variants that should be served for tiff.
webp	string[]	List of strings with the MIME types of all the variants that should be served for webp.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

zoneId^Required

public readonly zoneId: string;

• Type: string

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#zone_id ZoneCacheVariants#zone_id}

---

avif^Optional

public readonly avif: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for avif.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#avif ZoneCacheVariants#avif}

---

bmp^Optional

public readonly bmp: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for bmp.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#bmp ZoneCacheVariants#bmp}

---

gif^Optional

public readonly gif: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for gif.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#gif ZoneCacheVariants#gif}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#id ZoneCacheVariants#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.

---

jp2^Optional

public readonly jp2: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for jp2.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#jp2 ZoneCacheVariants#jp2}

---

jpeg^Optional

public readonly jpeg: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for jpeg.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#jpeg ZoneCacheVariants#jpeg}

---

jpg^Optional

public readonly jpg: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for jpg.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#jpg ZoneCacheVariants#jpg}

---

jpg2^Optional

public readonly jpg2: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for jpg2.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#jpg2 ZoneCacheVariants#jpg2}

---

png^Optional

public readonly png: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for png.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#png ZoneCacheVariants#png}

---

tif^Optional

public readonly tif: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for tif.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#tif ZoneCacheVariants#tif}

---

tiff^Optional

public readonly tiff: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for tiff.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#tiff ZoneCacheVariants#tiff}

---

webp^Optional

public readonly webp: string[];

• Type: string[]

List of strings with the MIME types of all the variants that should be served for webp.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/zone_cache_variants#webp ZoneCacheVariants#webp}

---