Skip to content

Latest commit

 

History

History
2390 lines (1484 loc) · 110 KB

functionAppFunction.java.md

File metadata and controls

2390 lines (1484 loc) · 110 KB
Raw

functionAppFunction Submodule

Constructs

FunctionAppFunction

Represents a {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function azurerm_function_app_function}.

Initializers 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunction;

FunctionAppFunction.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>)
    .configJson(java.lang.String)
    .functionAppId(java.lang.String)
    .name(java.lang.String)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .file(IResolvable)
//  .file(java.util.List<FunctionAppFunctionFile>)
//  .id(java.lang.String)
//  .language(java.lang.String)
//  .testData(java.lang.String)
//  .timeouts(FunctionAppFunctionTimeouts)
    .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.
configJson java.lang.String The config for this Function in JSON format.
functionAppId java.lang.String The ID of the Function App in which this function should reside.
name java.lang.String The name of the function.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Should this function be enabled. Defaults to true.
file com.hashicorp.cdktf.IResolvable OR java.util.List<FunctionAppFunctionFile> file block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#id FunctionAppFunction#id}.
language java.lang.String The language the Function is written in.
testData java.lang.String The test data for the function.
timeouts FunctionAppFunctionTimeouts timeouts block.
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>
configJsonRequired
  • Type: java.lang.String

The config for this Function in JSON format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#config_json FunctionAppFunction#config_json}

functionAppIdRequired
  • Type: java.lang.String

The ID of the Function App in which this function should reside.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#function_app_id FunctionAppFunction#function_app_id}

nameRequired
  • Type: java.lang.String

The name of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#name FunctionAppFunction#name}

enabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Should this function be enabled. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#enabled FunctionAppFunction#enabled}

fileOptional

file block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#file FunctionAppFunction#file}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#id FunctionAppFunction#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

languageOptional
  • Type: java.lang.String

The language the Function is written in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#language FunctionAppFunction#language}

testDataOptional
  • Type: java.lang.String

The test data for the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#test_data FunctionAppFunction#test_data}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#timeouts FunctionAppFunction#timeouts}

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".
putFile No description.
putTimeouts No description.
resetEnabled No description.
resetFile No description.
resetId No description.
resetLanguage No description.
resetTestData No description.
resetTimeouts 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".

putFile 
public void putFile(IResolvable OR java.util.List<FunctionAppFunctionFile> value)
valueRequired
putTimeouts 
public void putTimeouts(FunctionAppFunctionTimeouts value)
valueRequired
resetEnabled 
public void resetEnabled()
resetFile 
public void resetFile()
resetId 
public void resetId()
resetLanguage 
public void resetLanguage()
resetTestData 
public void resetTestData()
resetTimeouts 
public void resetTimeouts()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a FunctionAppFunction resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunction;

FunctionAppFunction.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.azurerm.function_app_function.FunctionAppFunction;

FunctionAppFunction.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunction;

FunctionAppFunction.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunction;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing FunctionAppFunction that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#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 FunctionAppFunction 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.
configUrl java.lang.String No description.
file FunctionAppFunctionFileList No description.
invocationUrl java.lang.String No description.
scriptRootPathUrl java.lang.String No description.
scriptUrl java.lang.String No description.
secretsFileUrl java.lang.String No description.
testDataUrl java.lang.String No description.
timeouts FunctionAppFunctionTimeoutsOutputReference No description.
url java.lang.String No description.
configJsonInput java.lang.String No description.
enabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
fileInput com.hashicorp.cdktf.IResolvable OR java.util.List<FunctionAppFunctionFile> No description.
functionAppIdInput java.lang.String No description.
idInput java.lang.String No description.
languageInput java.lang.String No description.
nameInput java.lang.String No description.
testDataInput java.lang.String No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR FunctionAppFunctionTimeouts No description.
configJson java.lang.String No description.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
functionAppId java.lang.String No description.
id java.lang.String No description.
language java.lang.String No description.
name java.lang.String No description.
testData 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>
configUrlRequired 
public java.lang.String getConfigUrl();
  • Type: java.lang.String
fileRequired 
public FunctionAppFunctionFileList getFile();
invocationUrlRequired 
public java.lang.String getInvocationUrl();
  • Type: java.lang.String
scriptRootPathUrlRequired 
public java.lang.String getScriptRootPathUrl();
  • Type: java.lang.String
scriptUrlRequired 
public java.lang.String getScriptUrl();
  • Type: java.lang.String
secretsFileUrlRequired 
public java.lang.String getSecretsFileUrl();
  • Type: java.lang.String
testDataUrlRequired 
public java.lang.String getTestDataUrl();
  • Type: java.lang.String
timeoutsRequired 
public FunctionAppFunctionTimeoutsOutputReference getTimeouts();
urlRequired 
public java.lang.String getUrl();
  • Type: java.lang.String
configJsonInputOptional 
public java.lang.String getConfigJsonInput();
  • Type: java.lang.String
enabledInputOptional 
public java.lang.Object getEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
fileInputOptional 
public java.lang.Object getFileInput();
functionAppIdInputOptional 
public java.lang.String getFunctionAppIdInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
languageInputOptional 
public java.lang.String getLanguageInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
testDataInputOptional 
public java.lang.String getTestDataInput();
  • Type: java.lang.String
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
configJsonRequired 
public java.lang.String getConfigJson();
  • Type: java.lang.String
enabledRequired 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
functionAppIdRequired 
public java.lang.String getFunctionAppId();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
languageRequired 
public java.lang.String getLanguage();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
testDataRequired 
public java.lang.String getTestData();
  • 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

FunctionAppFunctionConfig

Initializer 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunctionConfig;

FunctionAppFunctionConfig.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>)
    .configJson(java.lang.String)
    .functionAppId(java.lang.String)
    .name(java.lang.String)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .file(IResolvable)
//  .file(java.util.List<FunctionAppFunctionFile>)
//  .id(java.lang.String)
//  .language(java.lang.String)
//  .testData(java.lang.String)
//  .timeouts(FunctionAppFunctionTimeouts)
    .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.
configJson java.lang.String The config for this Function in JSON format.
functionAppId java.lang.String The ID of the Function App in which this function should reside.
name java.lang.String The name of the function.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Should this function be enabled. Defaults to true.
file com.hashicorp.cdktf.IResolvable OR java.util.List<FunctionAppFunctionFile> file block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#id FunctionAppFunction#id}.
language java.lang.String The language the Function is written in.
testData java.lang.String The test data for the function.
timeouts FunctionAppFunctionTimeouts timeouts block.
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>
configJsonRequired 
public java.lang.String getConfigJson();
  • Type: java.lang.String

The config for this Function in JSON format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#config_json FunctionAppFunction#config_json}

functionAppIdRequired 
public java.lang.String getFunctionAppId();
  • Type: java.lang.String

The ID of the Function App in which this function should reside.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#function_app_id FunctionAppFunction#function_app_id}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

The name of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#name FunctionAppFunction#name}

enabledOptional 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Should this function be enabled. Defaults to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#enabled FunctionAppFunction#enabled}

fileOptional 
public java.lang.Object getFile();

file block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#file FunctionAppFunction#file}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#id FunctionAppFunction#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

languageOptional 
public java.lang.String getLanguage();
  • Type: java.lang.String

The language the Function is written in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#language FunctionAppFunction#language}

testDataOptional 
public java.lang.String getTestData();
  • Type: java.lang.String

The test data for the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#test_data FunctionAppFunction#test_data}

timeoutsOptional 
public FunctionAppFunctionTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#timeouts FunctionAppFunction#timeouts}

FunctionAppFunctionFile

Initializer 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunctionFile;

FunctionAppFunctionFile.builder()
    .content(java.lang.String)
    .name(java.lang.String)
    .build();

Properties

Name Type Description
content java.lang.String The content of the file.
name java.lang.String The filename of the file to be uploaded.
contentRequired 
public java.lang.String getContent();
  • Type: java.lang.String

The content of the file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#content FunctionAppFunction#content}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

The filename of the file to be uploaded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#name FunctionAppFunction#name}

FunctionAppFunctionTimeouts

Initializer 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunctionTimeouts;

FunctionAppFunctionTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
//  .read(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#create FunctionAppFunction#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#delete FunctionAppFunction#delete}.
read java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#read FunctionAppFunction#read}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#update FunctionAppFunction#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#create FunctionAppFunction#create}.

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#delete FunctionAppFunction#delete}.

readOptional 
public java.lang.String getRead();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#read FunctionAppFunction#read}.

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azurerm/4.10.0/docs/resources/function_app_function#update FunctionAppFunction#update}.

Classes

FunctionAppFunctionFileList

Initializers 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunctionFileList;

new FunctionAppFunctionFileList(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 FunctionAppFunctionFileOutputReference 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<FunctionAppFunctionFile> 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();

FunctionAppFunctionFileOutputReference

Initializers 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunctionFileOutputReference;

new FunctionAppFunctionFileOutputReference(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.
nameInput java.lang.String No description.
content java.lang.String No description.
name java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR FunctionAppFunctionFile 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
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
contentRequired 
public java.lang.String getContent();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

FunctionAppFunctionTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.azurerm.function_app_function.FunctionAppFunctionTimeoutsOutputReference;

new FunctionAppFunctionTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
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.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetRead No description.
resetUpdate No description.
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.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()
resetRead 
public void resetRead()
resetUpdate 
public void resetUpdate()

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.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
readInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
read java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR FunctionAppFunctionTimeouts 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
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
readInputOptional 
public java.lang.String getReadInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
readRequired 
public java.lang.String getRead();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();