Skip to content

Latest commit

 

History

History
1816 lines (1116 loc) · 68 KB

file.typescript.md

File metadata and controls

1816 lines (1116 loc) · 68 KB

file Submodule

Constructs

File

Represents a {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file archive_file}.

Initializers 

import { file } from '@cdktf/provider-archive'

new file.File(scope: Construct, id: string, config: FileConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config FileConfig 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".
putSource No description.
resetExcludes No description.
resetExcludeSymlinkDirectories No description.
resetOutputFileMode No description.
resetSource No description.
resetSourceContent No description.
resetSourceContentFilename No description.
resetSourceDir No description.
resetSourceFile 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".

putSource 
public putSource(value: IResolvable | FileSource[]): void
valueRequired
resetExcludes 
public resetExcludes(): void
resetExcludeSymlinkDirectories 
public resetExcludeSymlinkDirectories(): void
resetOutputFileMode 
public resetOutputFileMode(): void
resetSource 
public resetSource(): void
resetSourceContent 
public resetSourceContent(): void
resetSourceContentFilename 
public resetSourceContentFilename(): void
resetSourceDir 
public resetSourceDir(): void
resetSourceFile 
public resetSourceFile(): 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 File resource upon running "cdktf plan ".
isConstruct 
import { file } from '@cdktf/provider-archive'

file.File.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 { file } from '@cdktf/provider-archive'

file.File.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { file } from '@cdktf/provider-archive'

file.File.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { file } from '@cdktf/provider-archive'

file.File.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing File that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#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 File 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.
id string No description.
outputBase64Sha256 string No description.
outputBase64Sha512 string No description.
outputMd5 string No description.
outputSha string No description.
outputSha256 string No description.
outputSha512 string No description.
outputSize number No description.
source FileSourceList No description.
excludesInput string[] No description.
excludeSymlinkDirectoriesInput boolean | cdktf.IResolvable No description.
outputFileModeInput string No description.
outputPathInput string No description.
sourceContentFilenameInput string No description.
sourceContentInput string No description.
sourceDirInput string No description.
sourceFileInput string No description.
sourceInput cdktf.IResolvable | FileSource[] No description.
typeInput string No description.
excludes string[] No description.
excludeSymlinkDirectories boolean | cdktf.IResolvable No description.
outputFileMode string No description.
outputPath string No description.
sourceContent string No description.
sourceContentFilename string No description.
sourceDir string No description.
sourceFile string No description.
type 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[]
idRequired 
public readonly id: string;
  • Type: string
outputBase64Sha256Required 
public readonly outputBase64Sha256: string;
  • Type: string
outputBase64Sha512Required 
public readonly outputBase64Sha512: string;
  • Type: string
outputMd5Required 
public readonly outputMd5: string;
  • Type: string
outputShaRequired 
public readonly outputSha: string;
  • Type: string
outputSha256Required 
public readonly outputSha256: string;
  • Type: string
outputSha512Required 
public readonly outputSha512: string;
  • Type: string
outputSizeRequired 
public readonly outputSize: number;
  • Type: number
sourceRequired 
public readonly source: FileSourceList;
excludesInputOptional 
public readonly excludesInput: string[];
  • Type: string[]
excludeSymlinkDirectoriesInputOptional 
public readonly excludeSymlinkDirectoriesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
outputFileModeInputOptional 
public readonly outputFileModeInput: string;
  • Type: string
outputPathInputOptional 
public readonly outputPathInput: string;
  • Type: string
sourceContentFilenameInputOptional 
public readonly sourceContentFilenameInput: string;
  • Type: string
sourceContentInputOptional 
public readonly sourceContentInput: string;
  • Type: string
sourceDirInputOptional 
public readonly sourceDirInput: string;
  • Type: string
sourceFileInputOptional 
public readonly sourceFileInput: string;
  • Type: string
sourceInputOptional 
public readonly sourceInput: IResolvable | FileSource[];
typeInputOptional 
public readonly typeInput: string;
  • Type: string
excludesRequired 
public readonly excludes: string[];
  • Type: string[]
excludeSymlinkDirectoriesRequired 
public readonly excludeSymlinkDirectories: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
outputFileModeRequired 
public readonly outputFileMode: string;
  • Type: string
outputPathRequired 
public readonly outputPath: string;
  • Type: string
sourceContentRequired 
public readonly sourceContent: string;
  • Type: string
sourceContentFilenameRequired 
public readonly sourceContentFilename: string;
  • Type: string
sourceDirRequired 
public readonly sourceDir: string;
  • Type: string
sourceFileRequired 
public readonly sourceFile: string;
  • Type: string
typeRequired 
public readonly type: string;
  • Type: string

Constants

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

Structs

FileConfig

Initializer 

import { file } from '@cdktf/provider-archive'

const fileConfig: file.FileConfig = { ... }

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.
outputPath string The output of the archive file.
type string The type of archive to generate. NOTE: zip and tar.gz is supported.
excludes string[] Specify files/directories to ignore when reading the source_dir. Supports glob file matching patterns including doublestar/globstar (**) patterns.
excludeSymlinkDirectories boolean | cdktf.IResolvable Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to false.
outputFileMode string String that specifies the octal file mode for all archived files.
source cdktf.IResolvable | FileSource[] source block.
sourceContent string Add only this content to the archive with source_content_filename as the filename.
sourceContentFilename string Set this as the filename when using source_content.
sourceDir string Package entire contents of this directory into the archive.
sourceFile string Package this file into the archive.
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[]
outputPathRequired 
public readonly outputPath: string;
  • Type: string

The output of the archive file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#output_path File#output_path}

typeRequired 
public readonly type: string;
  • Type: string

The type of archive to generate. NOTE: zip and tar.gz is supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#type File#type}

excludesOptional 
public readonly excludes: string[];
  • Type: string[]

Specify files/directories to ignore when reading the source_dir. Supports glob file matching patterns including doublestar/globstar (**) patterns.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#excludes File#excludes}

excludeSymlinkDirectoriesOptional 
public readonly excludeSymlinkDirectories: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#exclude_symlink_directories File#exclude_symlink_directories}

outputFileModeOptional 
public readonly outputFileMode: string;
  • Type: string

String that specifies the octal file mode for all archived files.

For example: "0666". Setting this will ensure that cross platform usage of this module will not vary the modes of archived files (and ultimately checksums) resulting in more deterministic behavior.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#output_file_mode File#output_file_mode}

sourceOptional 
public readonly source: IResolvable | FileSource[];

source block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#source File#source}

sourceContentOptional 
public readonly sourceContent: string;
  • Type: string

Add only this content to the archive with source_content_filename as the filename.

One and only one of source, source_content_filename (with source_content), source_file, or source_dir must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#source_content File#source_content}

sourceContentFilenameOptional 
public readonly sourceContentFilename: string;
  • Type: string

Set this as the filename when using source_content.

One and only one of source, source_content_filename (with source_content), source_file, or source_dir must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#source_content_filename File#source_content_filename}

sourceDirOptional 
public readonly sourceDir: string;
  • Type: string

Package entire contents of this directory into the archive.

One and only one of source, source_content_filename (with source_content), source_file, or source_dir must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#source_dir File#source_dir}

sourceFileOptional 
public readonly sourceFile: string;
  • Type: string

Package this file into the archive.

One and only one of source, source_content_filename (with source_content), source_file, or source_dir must be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#source_file File#source_file}

FileSource

Initializer 

import { file } from '@cdktf/provider-archive'

const fileSource: file.FileSource = { ... }

Properties

Name Type Description
content string Add this content to the archive with filename as the filename.
filename string Set this as the filename when declaring a source.
contentRequired 
public readonly content: string;
  • Type: string

Add this content to the archive with filename as the filename.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#content File#content}

filenameRequired 
public readonly filename: string;
  • Type: string

Set this as the filename when declaring a source.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/resources/file#filename File#filename}

Classes

FileSourceList

Initializers 

import { file } from '@cdktf/provider-archive'

new file.FileSourceList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): 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.

get 
public get(index: number): FileSourceOutputReference
indexRequired
  • Type: number

the index of the item to return.

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.
internalValue cdktf.IResolvable | FileSource[] 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
internalValueOptional 
public readonly internalValue: IResolvable | FileSource[];

FileSourceOutputReference

Initializers 

import { file } from '@cdktf/provider-archive'

new file.FileSourceOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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

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.
contentInput string No description.
filenameInput string No description.
content string No description.
filename string No description.
internalValue cdktf.IResolvable | FileSource 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
contentInputOptional 
public readonly contentInput: string;
  • Type: string
filenameInputOptional 
public readonly filenameInput: string;
  • Type: string
contentRequired 
public readonly content: string;
  • Type: string
filenameRequired 
public readonly filename: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | FileSource;