Represents a {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/data-sources/file archive_file}.
import { dataArchiveFile } from '@cdktf/provider-archive'
new dataArchiveFile.DataArchiveFile(scope: Construct, id: string, config: DataArchiveFileConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
DataArchiveFileConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: DataArchiveFileConfig
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 |
Adds this resource to the terraform JSON output. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
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. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public putSource(value: IResolvable | DataArchiveFileSource[]): void
- Type: cdktf.IResolvable | DataArchiveFileSource[]
public resetExcludes(): void
public resetExcludeSymlinkDirectories(): void
public resetOutputFileMode(): void
public resetSource(): void
public resetSourceContent(): void
public resetSourceContentFilename(): void
public resetSourceDir(): void
public resetSourceFile(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformDataSource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a DataArchiveFile resource upon running "cdktf plan ". |
import { dataArchiveFile } from '@cdktf/provider-archive'
dataArchiveFile.DataArchiveFile.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.
- Type: any
Any object.
import { dataArchiveFile } from '@cdktf/provider-archive'
dataArchiveFile.DataArchiveFile.isTerraformElement(x: any)
- Type: any
import { dataArchiveFile } from '@cdktf/provider-archive'
dataArchiveFile.DataArchiveFile.isTerraformDataSource(x: any)
- Type: any
import { dataArchiveFile } from '@cdktf/provider-archive'
dataArchiveFile.DataArchiveFile.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a DataArchiveFile resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the DataArchiveFile to import.
- Type: string
The id of the existing DataArchiveFile that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/data-sources/file#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the DataArchiveFile to import is found.
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. |
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. |
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 |
DataArchiveFileSourceList |
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 | DataArchiveFileSource[] |
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. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly id: string;
- Type: string
public readonly outputBase64Sha256: string;
- Type: string
public readonly outputBase64Sha512: string;
- Type: string
public readonly outputMd5: string;
- Type: string
public readonly outputSha: string;
- Type: string
public readonly outputSha256: string;
- Type: string
public readonly outputSha512: string;
- Type: string
public readonly outputSize: number;
- Type: number
public readonly source: DataArchiveFileSourceList;
public readonly excludesInput: string[];
- Type: string[]
public readonly excludeSymlinkDirectoriesInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly outputFileModeInput: string;
- Type: string
public readonly outputPathInput: string;
- Type: string
public readonly sourceContentFilenameInput: string;
- Type: string
public readonly sourceContentInput: string;
- Type: string
public readonly sourceDirInput: string;
- Type: string
public readonly sourceFileInput: string;
- Type: string
public readonly sourceInput: IResolvable | DataArchiveFileSource[];
- Type: cdktf.IResolvable | DataArchiveFileSource[]
public readonly typeInput: string;
- Type: string
public readonly excludes: string[];
- Type: string[]
public readonly excludeSymlinkDirectories: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly outputFileMode: string;
- Type: string
public readonly outputPath: string;
- Type: string
public readonly sourceContent: string;
- Type: string
public readonly sourceContentFilename: string;
- Type: string
public readonly sourceDir: string;
- Type: string
public readonly sourceFile: string;
- Type: string
public readonly type: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { dataArchiveFile } from '@cdktf/provider-archive'
const dataArchiveFileConfig: dataArchiveFile.DataArchiveFileConfig = { ... }
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 | DataArchiveFileSource[] |
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. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
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/data-sources/file#output_path DataArchiveFile#output_path}
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/data-sources/file#type DataArchiveFile#type}
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/data-sources/file#excludes DataArchiveFile#excludes}
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/data-sources/file#exclude_symlink_directories DataArchiveFile#exclude_symlink_directories}
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/data-sources/file#output_file_mode DataArchiveFile#output_file_mode}
public readonly source: IResolvable | DataArchiveFileSource[];
- Type: cdktf.IResolvable | DataArchiveFileSource[]
source block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/archive/2.7.0/docs/data-sources/file#source DataArchiveFile#source}
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/data-sources/file#source_content DataArchiveFile#source_content}
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/data-sources/file#source_content_filename DataArchiveFile#source_content_filename}
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/data-sources/file#source_dir DataArchiveFile#source_dir}
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/data-sources/file#source_file DataArchiveFile#source_file}
import { dataArchiveFile } from '@cdktf/provider-archive'
const dataArchiveFileSource: dataArchiveFile.DataArchiveFileSource = { ... }
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 . |
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/data-sources/file#content DataArchiveFile#content}
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/data-sources/file#filename DataArchiveFile#filename}
import { dataArchiveFile } from '@cdktf/provider-archive'
new dataArchiveFile.DataArchiveFileSourceList(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). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
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.
- Type: string
public computeFqn(): string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public get(index: number): DataArchiveFileSourceOutputReference
- Type: number
the index of the item to return.
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 | DataArchiveFileSource[] |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly internalValue: IResolvable | DataArchiveFileSource[];
- Type: cdktf.IResolvable | DataArchiveFileSource[]
import { dataArchiveFile } from '@cdktf/provider-archive'
new dataArchiveFile.DataArchiveFileSourceOutputReference(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). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: number
the index of this item in the list.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
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 | DataArchiveFileSource |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly contentInput: string;
- Type: string
public readonly filenameInput: string;
- Type: string
public readonly content: string;
- Type: string
public readonly filename: string;
- Type: string
public readonly internalValue: IResolvable | DataArchiveFileSource;
- Type: cdktf.IResolvable | DataArchiveFileSource