Skip to content

Latest commit

 

History

History
2031 lines (1258 loc) · 82.5 KB

file.java.md

File metadata and controls

2031 lines (1258 loc) · 82.5 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 com.hashicorp.cdktf.providers.archive.file.File;

File.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .outputPath(java.lang.String)
    .type(java.lang.String)
//  .excludes(java.util.List<java.lang.String>)
//  .excludeSymlinkDirectories(java.lang.Boolean)
//  .excludeSymlinkDirectories(IResolvable)
//  .outputFileMode(java.lang.String)
//  .source(IResolvable)
//  .source(java.util.List<FileSource>)
//  .sourceContent(java.lang.String)
//  .sourceContentFilename(java.lang.String)
//  .sourceDir(java.lang.String)
//  .sourceFile(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
outputPath java.lang.String The output of the archive file.
type java.lang.String The type of archive to generate. NOTE: zip and tar.gz is supported.
excludes java.util.List<java.lang.String> Specify files/directories to ignore when reading the source_dir. Supports glob file matching patterns including doublestar/globstar (**) patterns.
excludeSymlinkDirectories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to false.
outputFileMode java.lang.String String that specifies the octal file mode for all archived files.
source com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource> source block.
sourceContent java.lang.String Add only this content to the archive with source_content_filename as the filename.
sourceContentFilename java.lang.String Set this as the filename when using source_content.
sourceDir java.lang.String Package entire contents of this directory into the archive.
sourceFile java.lang.String Package this file into the archive.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
outputPathRequired
  • Type: java.lang.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
  • Type: java.lang.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
  • Type: java.util.List<java.lang.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
  • Type: java.lang.Boolean OR com.hashicorp.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
  • Type: java.lang.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
  • Type: com.hashicorp.cdktf.IResolvable OR java.util.List<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
  • Type: java.lang.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
  • Type: java.lang.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
  • Type: java.lang.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
  • Type: java.lang.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}

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 java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putSource 
public void putSource(IResolvable OR java.util.List<FileSource> value)
valueRequired
  • Type: com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource>
resetExcludes 
public void resetExcludes()
resetExcludeSymlinkDirectories 
public void resetExcludeSymlinkDirectories()
resetOutputFileMode 
public void resetOutputFileMode()
resetSource 
public void resetSource()
resetSourceContent 
public void resetSourceContent()
resetSourceContentFilename 
public void resetSourceContentFilename()
resetSourceDir 
public void resetSourceDir()
resetSourceFile 
public void resetSourceFile()

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 com.hashicorp.cdktf.providers.archive.file.File;

File.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.archive.file.File;

File.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.archive.file.File;

File.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.archive.file.File;

File.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),File.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a File resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the File to import.

importFromIdRequired
  • Type: java.lang.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: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the File to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
id java.lang.String No description.
outputBase64Sha256 java.lang.String No description.
outputBase64Sha512 java.lang.String No description.
outputMd5 java.lang.String No description.
outputSha java.lang.String No description.
outputSha256 java.lang.String No description.
outputSha512 java.lang.String No description.
outputSize java.lang.Number No description.
source FileSourceList No description.
excludesInput java.util.List<java.lang.String> No description.
excludeSymlinkDirectoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
outputFileModeInput java.lang.String No description.
outputPathInput java.lang.String No description.
sourceContentFilenameInput java.lang.String No description.
sourceContentInput java.lang.String No description.
sourceDirInput java.lang.String No description.
sourceFileInput java.lang.String No description.
sourceInput com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource> No description.
typeInput java.lang.String No description.
excludes java.util.List<java.lang.String> No description.
excludeSymlinkDirectories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
outputFileMode java.lang.String No description.
outputPath java.lang.String No description.
sourceContent java.lang.String No description.
sourceContentFilename java.lang.String No description.
sourceDir java.lang.String No description.
sourceFile java.lang.String No description.
type java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
outputBase64Sha256Required 
public java.lang.String getOutputBase64Sha256();
  • Type: java.lang.String
outputBase64Sha512Required 
public java.lang.String getOutputBase64Sha512();
  • Type: java.lang.String
outputMd5Required 
public java.lang.String getOutputMd5();
  • Type: java.lang.String
outputShaRequired 
public java.lang.String getOutputSha();
  • Type: java.lang.String
outputSha256Required 
public java.lang.String getOutputSha256();
  • Type: java.lang.String
outputSha512Required 
public java.lang.String getOutputSha512();
  • Type: java.lang.String
outputSizeRequired 
public java.lang.Number getOutputSize();
  • Type: java.lang.Number
sourceRequired 
public FileSourceList getSource();
excludesInputOptional 
public java.util.List<java.lang.String> getExcludesInput();
  • Type: java.util.List<java.lang.String>
excludeSymlinkDirectoriesInputOptional 
public java.lang.Object getExcludeSymlinkDirectoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
outputFileModeInputOptional 
public java.lang.String getOutputFileModeInput();
  • Type: java.lang.String
outputPathInputOptional 
public java.lang.String getOutputPathInput();
  • Type: java.lang.String
sourceContentFilenameInputOptional 
public java.lang.String getSourceContentFilenameInput();
  • Type: java.lang.String
sourceContentInputOptional 
public java.lang.String getSourceContentInput();
  • Type: java.lang.String
sourceDirInputOptional 
public java.lang.String getSourceDirInput();
  • Type: java.lang.String
sourceFileInputOptional 
public java.lang.String getSourceFileInput();
  • Type: java.lang.String
sourceInputOptional 
public java.lang.Object getSourceInput();
  • Type: com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource>
typeInputOptional 
public java.lang.String getTypeInput();
  • Type: java.lang.String
excludesRequired 
public java.util.List<java.lang.String> getExcludes();
  • Type: java.util.List<java.lang.String>
excludeSymlinkDirectoriesRequired 
public java.lang.Object getExcludeSymlinkDirectories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
outputFileModeRequired 
public java.lang.String getOutputFileMode();
  • Type: java.lang.String
outputPathRequired 
public java.lang.String getOutputPath();
  • Type: java.lang.String
sourceContentRequired 
public java.lang.String getSourceContent();
  • Type: java.lang.String
sourceContentFilenameRequired 
public java.lang.String getSourceContentFilename();
  • Type: java.lang.String
sourceDirRequired 
public java.lang.String getSourceDir();
  • Type: java.lang.String
sourceFileRequired 
public java.lang.String getSourceFile();
  • Type: java.lang.String
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

FileConfig

Initializer 

import com.hashicorp.cdktf.providers.archive.file.FileConfig;

FileConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .outputPath(java.lang.String)
    .type(java.lang.String)
//  .excludes(java.util.List<java.lang.String>)
//  .excludeSymlinkDirectories(java.lang.Boolean)
//  .excludeSymlinkDirectories(IResolvable)
//  .outputFileMode(java.lang.String)
//  .source(IResolvable)
//  .source(java.util.List<FileSource>)
//  .sourceContent(java.lang.String)
//  .sourceContentFilename(java.lang.String)
//  .sourceDir(java.lang.String)
//  .sourceFile(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
outputPath java.lang.String The output of the archive file.
type java.lang.String The type of archive to generate. NOTE: zip and tar.gz is supported.
excludes java.util.List<java.lang.String> Specify files/directories to ignore when reading the source_dir. Supports glob file matching patterns including doublestar/globstar (**) patterns.
excludeSymlinkDirectories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Boolean flag indicating whether symbolically linked directories should be excluded during the creation of the archive. Defaults to false.
outputFileMode java.lang.String String that specifies the octal file mode for all archived files.
source com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource> source block.
sourceContent java.lang.String Add only this content to the archive with source_content_filename as the filename.
sourceContentFilename java.lang.String Set this as the filename when using source_content.
sourceDir java.lang.String Package entire contents of this directory into the archive.
sourceFile java.lang.String Package this file into the archive.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
outputPathRequired 
public java.lang.String getOutputPath();
  • Type: java.lang.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 java.lang.String getType();
  • Type: java.lang.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 java.util.List<java.lang.String> getExcludes();
  • Type: java.util.List<java.lang.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 java.lang.Object getExcludeSymlinkDirectories();
  • Type: java.lang.Boolean OR com.hashicorp.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 java.lang.String getOutputFileMode();
  • Type: java.lang.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 java.lang.Object getSource();
  • Type: com.hashicorp.cdktf.IResolvable OR java.util.List<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 java.lang.String getSourceContent();
  • Type: java.lang.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 java.lang.String getSourceContentFilename();
  • Type: java.lang.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 java.lang.String getSourceDir();
  • Type: java.lang.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 java.lang.String getSourceFile();
  • Type: java.lang.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 com.hashicorp.cdktf.providers.archive.file.FileSource;

FileSource.builder()
    .content(java.lang.String)
    .filename(java.lang.String)
    .build();

Properties

Name Type Description
content java.lang.String Add this content to the archive with filename as the filename.
filename java.lang.String Set this as the filename when declaring a source.
contentRequired 
public java.lang.String getContent();
  • Type: java.lang.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 java.lang.String getFilename();
  • Type: java.lang.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 com.hashicorp.cdktf.providers.archive.file.FileSourceList;

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

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.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 DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

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

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public FileSourceOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();
  • Type: com.hashicorp.cdktf.IResolvable OR java.util.List<FileSource>

FileSourceOutputReference

Initializers 

import com.hashicorp.cdktf.providers.archive.file.FileSourceOutputReference;

new FileSourceOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
contentInput java.lang.String No description.
filenameInput java.lang.String No description.
content java.lang.String No description.
filename java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR FileSource No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
contentInputOptional 
public java.lang.String getContentInput();
  • Type: java.lang.String
filenameInputOptional 
public java.lang.String getFilenameInput();
  • Type: java.lang.String
contentRequired 
public java.lang.String getContent();
  • Type: java.lang.String
filenameRequired 
public java.lang.String getFilename();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();
  • Type: com.hashicorp.cdktf.IResolvable OR FileSource