Skip to content

Latest commit

 

History

History
1742 lines (1083 loc) · 75.2 KB

imagesImageV2.typescript.md

File metadata and controls

1742 lines (1083 loc) · 75.2 KB
Raw

imagesImageV2 Submodule

Constructs

ImagesImageV2

Represents a {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2 opentelekomcloud_images_image_v2}.

Initializers 

import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

new imagesImageV2.ImagesImageV2(scope: Construct, id: string, config: ImagesImageV2Config)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ImagesImageV2Config 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 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".
putTimeouts No description.
resetId No description.
resetImageCachePath No description.
resetImageSourceUrl No description.
resetLocalFilePath No description.
resetMinDiskGb No description.
resetMinRamMb No description.
resetProtected No description.
resetRegion No description.
resetTags No description.
resetTimeouts No description.
resetVisibility 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
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: cdktf.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".

putTimeouts 
public putTimeouts(value: ImagesImageV2Timeouts): void
valueRequired
resetId 
public resetId(): void
resetImageCachePath 
public resetImageCachePath(): void
resetImageSourceUrl 
public resetImageSourceUrl(): void
resetLocalFilePath 
public resetLocalFilePath(): void
resetMinDiskGb 
public resetMinDiskGb(): void
resetMinRamMb 
public resetMinRamMb(): void
resetProtected 
public resetProtected(): void
resetRegion 
public resetRegion(): void
resetTags 
public resetTags(): void
resetTimeouts 
public resetTimeouts(): void
resetVisibility 
public resetVisibility(): 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 ImagesImageV2 resource upon running "cdktf plan ".
isConstruct 
import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

imagesImageV2.ImagesImageV2.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 { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

imagesImageV2.ImagesImageV2.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

imagesImageV2.ImagesImageV2.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

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

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

importFromIdRequired
  • Type: string

The id of the existing ImagesImageV2 that should be imported.

Refer to the {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#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 ImagesImageV2 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.
checksum string No description.
createdAt string No description.
file string No description.
owner string No description.
schema string No description.
sizeBytes number No description.
status string No description.
timeouts ImagesImageV2TimeoutsOutputReference No description.
updateAt string No description.
containerFormatInput string No description.
diskFormatInput string No description.
idInput string No description.
imageCachePathInput string No description.
imageSourceUrlInput string No description.
localFilePathInput string No description.
minDiskGbInput number No description.
minRamMbInput number No description.
nameInput string No description.
protectedInput boolean | cdktf.IResolvable No description.
regionInput string No description.
tagsInput string[] No description.
timeoutsInput cdktf.IResolvable | ImagesImageV2Timeouts No description.
visibilityInput string No description.
containerFormat string No description.
diskFormat string No description.
id string No description.
imageCachePath string No description.
imageSourceUrl string No description.
localFilePath string No description.
minDiskGb number No description.
minRamMb number No description.
name string No description.
protected boolean | cdktf.IResolvable No description.
region string No description.
tags string[] No description.
visibility string 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
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: 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
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
checksumRequired 
public readonly checksum: string;
  • Type: string
createdAtRequired 
public readonly createdAt: string;
  • Type: string
fileRequired 
public readonly file: string;
  • Type: string
ownerRequired 
public readonly owner: string;
  • Type: string
schemaRequired 
public readonly schema: string;
  • Type: string
sizeBytesRequired 
public readonly sizeBytes: number;
  • Type: number
statusRequired 
public readonly status: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: ImagesImageV2TimeoutsOutputReference;
updateAtRequired 
public readonly updateAt: string;
  • Type: string
containerFormatInputOptional 
public readonly containerFormatInput: string;
  • Type: string
diskFormatInputOptional 
public readonly diskFormatInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
imageCachePathInputOptional 
public readonly imageCachePathInput: string;
  • Type: string
imageSourceUrlInputOptional 
public readonly imageSourceUrlInput: string;
  • Type: string
localFilePathInputOptional 
public readonly localFilePathInput: string;
  • Type: string
minDiskGbInputOptional 
public readonly minDiskGbInput: number;
  • Type: number
minRamMbInputOptional 
public readonly minRamMbInput: number;
  • Type: number
nameInputOptional 
public readonly nameInput: string;
  • Type: string
protectedInputOptional 
public readonly protectedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
regionInputOptional 
public readonly regionInput: string;
  • Type: string
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | ImagesImageV2Timeouts;
visibilityInputOptional 
public readonly visibilityInput: string;
  • Type: string
containerFormatRequired 
public readonly containerFormat: string;
  • Type: string
diskFormatRequired 
public readonly diskFormat: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
imageCachePathRequired 
public readonly imageCachePath: string;
  • Type: string
imageSourceUrlRequired 
public readonly imageSourceUrl: string;
  • Type: string
localFilePathRequired 
public readonly localFilePath: string;
  • Type: string
minDiskGbRequired 
public readonly minDiskGb: number;
  • Type: number
minRamMbRequired 
public readonly minRamMb: number;
  • Type: number
nameRequired 
public readonly name: string;
  • Type: string
protectedRequired 
public readonly protected: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
regionRequired 
public readonly region: string;
  • Type: string
tagsRequired 
public readonly tags: string[];
  • Type: string[]
visibilityRequired 
public readonly visibility: string;
  • Type: string

Constants

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

Structs

ImagesImageV2Config

Initializer 

import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

const imagesImageV2Config: imagesImageV2.ImagesImageV2Config = { ... }

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.
containerFormat string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#container_format ImagesImageV2#container_format}.
diskFormat string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#disk_format ImagesImageV2#disk_format}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#name ImagesImageV2#name}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#id ImagesImageV2#id}.
imageCachePath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#image_cache_path ImagesImageV2#image_cache_path}.
imageSourceUrl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#image_source_url ImagesImageV2#image_source_url}.
localFilePath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#local_file_path ImagesImageV2#local_file_path}.
minDiskGb number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#min_disk_gb ImagesImageV2#min_disk_gb}.
minRamMb number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#min_ram_mb ImagesImageV2#min_ram_mb}.
protected boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#protected ImagesImageV2#protected}.
region string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#region ImagesImageV2#region}.
tags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#tags ImagesImageV2#tags}.
timeouts ImagesImageV2Timeouts timeouts block.
visibility string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#visibility ImagesImageV2#visibility}.
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[]
containerFormatRequired 
public readonly containerFormat: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#container_format ImagesImageV2#container_format}.

diskFormatRequired 
public readonly diskFormat: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#disk_format ImagesImageV2#disk_format}.

nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#name ImagesImageV2#name}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#id ImagesImageV2#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.

imageCachePathOptional 
public readonly imageCachePath: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#image_cache_path ImagesImageV2#image_cache_path}.

imageSourceUrlOptional 
public readonly imageSourceUrl: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#image_source_url ImagesImageV2#image_source_url}.

localFilePathOptional 
public readonly localFilePath: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#local_file_path ImagesImageV2#local_file_path}.

minDiskGbOptional 
public readonly minDiskGb: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#min_disk_gb ImagesImageV2#min_disk_gb}.

minRamMbOptional 
public readonly minRamMb: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#min_ram_mb ImagesImageV2#min_ram_mb}.

protectedOptional 
public readonly protected: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#protected ImagesImageV2#protected}.

regionOptional 
public readonly region: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#region ImagesImageV2#region}.

tagsOptional 
public readonly tags: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#tags ImagesImageV2#tags}.

timeoutsOptional 
public readonly timeouts: ImagesImageV2Timeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#timeouts ImagesImageV2#timeouts}

visibilityOptional 
public readonly visibility: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#visibility ImagesImageV2#visibility}.

ImagesImageV2Timeouts

Initializer 

import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

const imagesImageV2Timeouts: imagesImageV2.ImagesImageV2Timeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#create ImagesImageV2#create}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.10/docs/resources/images_image_v2#create ImagesImageV2#create}.

Classes

ImagesImageV2TimeoutsOutputReference

Initializers 

import { imagesImageV2 } from '@cdktf/provider-opentelekomcloud'

new imagesImageV2.ImagesImageV2TimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
computeFqn 
public computeFqn(): string
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(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public resetCreate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
create string No description.
internalValue cdktf.IResolvable | ImagesImageV2Timeouts No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
createInputOptional 
public readonly createInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ImagesImageV2Timeouts;