Skip to content

image.typescript.md

Latest commit

 

History

History
1123 lines (694 loc) · 40.9 KB

image.typescript.md

File metadata and controls

1123 lines (694 loc) · 40.9 KB
Raw

image Submodule

Constructs

Image

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image cloudflare_image}.

Initializers 

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

new image.Image(scope: Construct, id: string, config: ImageConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ImageConfig 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.
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 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".
resetCreator No description.
resetFile No description.
resetMetadata No description.
resetRequireSignedUrls No description.
resetUrl 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.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

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
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktn.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

resetCreator 
public resetCreator(): void
resetFile 
public resetFile(): void
resetMetadata 
public resetMetadata(): void
resetRequireSignedUrls 
public resetRequireSignedUrls(): void
resetUrl 
public resetUrl(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTN code for importing a Image resource upon running "cdktn plan ".
isConstruct 
import { image } from '@cdktn/provider-cloudflare'

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

image.Image.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { image } from '@cdktn/provider-cloudflare'

image.Image.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { image } from '@cdktn/provider-cloudflare'

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

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

importFromIdRequired
  • Type: string

The id of the existing Image that should be imported.

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

providerOptional
  • Type: cdktn.TerraformProvider

? Optional instance of the provider where the Image 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.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection 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.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
filename string No description.
meta string No description.
uploaded string No description.
variants string[] No description.
accountIdInput string No description.
creatorInput string No description.
fileInput string No description.
idInput string No description.
metadataInput string No description.
requireSignedUrlsInput boolean | cdktn.IResolvable No description.
urlInput string No description.
accountId string No description.
creator string No description.
file string No description.
id string No description.
metadata string No description.
requireSignedUrls boolean | cdktn.IResolvable No description.
url string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider
provisionersOptional 
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]
filenameRequired 
public readonly filename: string;
  • Type: string
metaRequired 
public readonly meta: string;
  • Type: string
uploadedRequired 
public readonly uploaded: string;
  • Type: string
variantsRequired 
public readonly variants: string[];
  • Type: string[]
accountIdInputOptional 
public readonly accountIdInput: string;
  • Type: string
creatorInputOptional 
public readonly creatorInput: string;
  • Type: string
fileInputOptional 
public readonly fileInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
metadataInputOptional 
public readonly metadataInput: string;
  • Type: string
requireSignedUrlsInputOptional 
public readonly requireSignedUrlsInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable
urlInputOptional 
public readonly urlInput: string;
  • Type: string
accountIdRequired 
public readonly accountId: string;
  • Type: string
creatorRequired 
public readonly creator: string;
  • Type: string
fileRequired 
public readonly file: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
metadataRequired 
public readonly metadata: string;
  • Type: string
requireSignedUrlsRequired 
public readonly requireSignedUrls: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable
urlRequired 
public readonly url: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

ImageConfig

Initializer 

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

const imageConfig: image.ImageConfig = { ... }

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.
accountId string Account identifier tag.
id string An optional custom unique identifier for your image.
creator string Can set the creator field with an internal user ID.
file string An image binary data. Only needed when type is uploading a file.
metadata string User modifiable key-value store. Can use used for keeping references to another system of record for managing images.
requireSignedUrls boolean | cdktn.IResolvable Indicates whether the image requires a signature token for the access.
url string A URL to fetch an image from origin. Only needed when type is uploading from a URL.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktn.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider
provisionersOptional 
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]
accountIdRequired 
public readonly accountId: string;
  • Type: string

Account identifier tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image#account_id Image#account_id}

idRequired 
public readonly id: string;
  • Type: string

An optional custom unique identifier for your image.

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

creatorOptional 
public readonly creator: string;
  • Type: string

Can set the creator field with an internal user ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image#creator Image#creator}

fileOptional 
public readonly file: string;
  • Type: string

An image binary data. Only needed when type is uploading a file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image#file Image#file}

metadataOptional 
public readonly metadata: string;
  • Type: string

User modifiable key-value store. Can use used for keeping references to another system of record for managing images.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image#metadata Image#metadata}

requireSignedUrlsOptional 
public readonly requireSignedUrls: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Indicates whether the image requires a signature token for the access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image#require_signed_urls Image#require_signed_urls}

urlOptional 
public readonly url: string;
  • Type: string

A URL to fetch an image from origin. Only needed when type is uploading from a URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.22.0/docs/resources/image#url Image#url}