Skip to content

Latest commit

 

History

History
1800 lines (1123 loc) · 76 KB

dialogflowAgent.typescript.md

File metadata and controls

1800 lines (1123 loc) · 76 KB

dialogflowAgent Submodule

Constructs

DialogflowAgent

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent google_dialogflow_agent}.

Initializers

import { dialogflowAgent } from '@cdktf/provider-google'

new dialogflowAgent.DialogflowAgent(scope: Construct, id: string, config: DialogflowAgentConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DialogflowAgentConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTimeouts No description.
resetApiVersion No description.
resetAvatarUri No description.
resetClassificationThreshold No description.
resetDescription No description.
resetEnableLogging No description.
resetId No description.
resetMatchMode No description.
resetProject No description.
resetSupportedLanguageCodes No description.
resetTier No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

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


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putTimeouts
public putTimeouts(value: DialogflowAgentTimeouts): void
valueRequired

resetApiVersion
public resetApiVersion(): void
resetAvatarUri
public resetAvatarUri(): void
resetClassificationThreshold
public resetClassificationThreshold(): void
resetDescription
public resetDescription(): void
resetEnableLogging
public resetEnableLogging(): void
resetId
public resetId(): void
resetMatchMode
public resetMatchMode(): void
resetProject
public resetProject(): void
resetSupportedLanguageCodes
public resetSupportedLanguageCodes(): void
resetTier
public resetTier(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a DialogflowAgent resource upon running "cdktf plan ".

isConstruct
import { dialogflowAgent } from '@cdktf/provider-google'

dialogflowAgent.DialogflowAgent.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.


isTerraformElement
import { dialogflowAgent } from '@cdktf/provider-google'

dialogflowAgent.DialogflowAgent.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { dialogflowAgent } from '@cdktf/provider-google'

dialogflowAgent.DialogflowAgent.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dialogflowAgent } from '@cdktf/provider-google'

dialogflowAgent.DialogflowAgent.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing DialogflowAgent that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
avatarUriBackend string No description.
timeouts DialogflowAgentTimeoutsOutputReference No description.
apiVersionInput string No description.
avatarUriInput string No description.
classificationThresholdInput number No description.
defaultLanguageCodeInput string No description.
descriptionInput string No description.
displayNameInput string No description.
enableLoggingInput boolean | cdktf.IResolvable No description.
idInput string No description.
matchModeInput string No description.
projectInput string No description.
supportedLanguageCodesInput string[] No description.
tierInput string No description.
timeoutsInput cdktf.IResolvable | DialogflowAgentTimeouts No description.
timeZoneInput string No description.
apiVersion string No description.
avatarUri string No description.
classificationThreshold number No description.
defaultLanguageCode string No description.
description string No description.
displayName string No description.
enableLogging boolean | cdktf.IResolvable No description.
id string No description.
matchMode string No description.
project string No description.
supportedLanguageCodes string[] No description.
tier string No description.
timeZone string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

avatarUriBackendRequired
public readonly avatarUriBackend: string;
  • Type: string

timeoutsRequired
public readonly timeouts: DialogflowAgentTimeoutsOutputReference;

apiVersionInputOptional
public readonly apiVersionInput: string;
  • Type: string

avatarUriInputOptional
public readonly avatarUriInput: string;
  • Type: string

classificationThresholdInputOptional
public readonly classificationThresholdInput: number;
  • Type: number

defaultLanguageCodeInputOptional
public readonly defaultLanguageCodeInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

displayNameInputOptional
public readonly displayNameInput: string;
  • Type: string

enableLoggingInputOptional
public readonly enableLoggingInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

matchModeInputOptional
public readonly matchModeInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

supportedLanguageCodesInputOptional
public readonly supportedLanguageCodesInput: string[];
  • Type: string[]

tierInputOptional
public readonly tierInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | DialogflowAgentTimeouts;

timeZoneInputOptional
public readonly timeZoneInput: string;
  • Type: string

apiVersionRequired
public readonly apiVersion: string;
  • Type: string

avatarUriRequired
public readonly avatarUri: string;
  • Type: string

classificationThresholdRequired
public readonly classificationThreshold: number;
  • Type: number

defaultLanguageCodeRequired
public readonly defaultLanguageCode: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

displayNameRequired
public readonly displayName: string;
  • Type: string

enableLoggingRequired
public readonly enableLogging: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

matchModeRequired
public readonly matchMode: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

supportedLanguageCodesRequired
public readonly supportedLanguageCodes: string[];
  • Type: string[]

tierRequired
public readonly tier: string;
  • Type: string

timeZoneRequired
public readonly timeZone: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DialogflowAgentConfig

Initializer

import { dialogflowAgent } from '@cdktf/provider-google'

const dialogflowAgentConfig: dialogflowAgent.DialogflowAgentConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
defaultLanguageCode string The default language of the agent as a language tag.
displayName string The name of this agent.
timeZone string The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
apiVersion string API version displayed in Dialogflow console.
avatarUri string The URI of the agent's avatar, which are used throughout the Dialogflow console.
classificationThreshold number To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold.
description string The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
enableLogging boolean | cdktf.IResolvable Determines whether this agent should log conversation queries.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#id DialogflowAgent#id}.
matchMode string Determines how intents are detected from user queries.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#project DialogflowAgent#project}.
supportedLanguageCodes string[] The list of all languages supported by this agent (except for the defaultLanguageCode).
tier string The agent tier.
timeouts DialogflowAgentTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

defaultLanguageCodeRequired
public readonly defaultLanguageCode: string;
  • Type: string

The default language of the agent as a language tag.

See Language Support for a list of the currently supported language codes. This field cannot be updated after creation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#default_language_code DialogflowAgent#default_language_code}


displayNameRequired
public readonly displayName: string;
  • Type: string

The name of this agent.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#display_name DialogflowAgent#display_name}


timeZoneRequired
public readonly timeZone: string;
  • Type: string

The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#time_zone DialogflowAgent#time_zone}


apiVersionOptional
public readonly apiVersion: string;
  • Type: string

API version displayed in Dialogflow console.

If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.

  • API_VERSION_V1: Legacy V1 API.
  • API_VERSION_V2: V2 API.
  • API_VERSION_V2_BETA_1: V2beta1 API. Possible values: ["API_VERSION_V1", "API_VERSION_V2", "API_VERSION_V2_BETA_1"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#api_version DialogflowAgent#api_version}


avatarUriOptional
public readonly avatarUri: string;
  • Type: string

The URI of the agent's avatar, which are used throughout the Dialogflow console.

When an image URL is entered into this field, the Dialogflow will save the image in the backend. The address of the backend image returned from the API will be shown in the [avatarUriBackend] field.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#avatar_uri DialogflowAgent#avatar_uri}


classificationThresholdOptional
public readonly classificationThreshold: number;
  • Type: number

To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold.

If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#classification_threshold DialogflowAgent#classification_threshold}


descriptionOptional
public readonly description: string;
  • Type: string

The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#description DialogflowAgent#description}


enableLoggingOptional
public readonly enableLogging: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Determines whether this agent should log conversation queries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#enable_logging DialogflowAgent#enable_logging}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#id DialogflowAgent#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.


matchModeOptional
public readonly matchMode: string;
  • Type: string

Determines how intents are detected from user queries.

  • MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.
  • MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones using

projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#project DialogflowAgent#project}.


supportedLanguageCodesOptional
public readonly supportedLanguageCodes: string[];
  • Type: string[]

The list of all languages supported by this agent (except for the defaultLanguageCode).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#supported_language_codes DialogflowAgent#supported_language_codes}


tierOptional
public readonly tier: string;
  • Type: string

The agent tier.

If not specified, TIER_STANDARD is assumed.

  • TIER_STANDARD: Standard tier.
  • TIER_ENTERPRISE: Enterprise tier (Essentials).
  • TIER_ENTERPRISE_PLUS: Enterprise tier (Plus). NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between the Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#tier DialogflowAgent#tier}


timeoutsOptional
public readonly timeouts: DialogflowAgentTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#timeouts DialogflowAgent#timeouts}


DialogflowAgentTimeouts

Initializer

import { dialogflowAgent } from '@cdktf/provider-google'

const dialogflowAgentTimeouts: dialogflowAgent.DialogflowAgentTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#create DialogflowAgent#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#delete DialogflowAgent#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#update DialogflowAgent#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#create DialogflowAgent#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#delete DialogflowAgent#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/dialogflow_agent#update DialogflowAgent#update}.


Classes

DialogflowAgentTimeoutsOutputReference

Initializers

import { dialogflowAgent } from '@cdktf/provider-google'

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

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

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

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | DialogflowAgentTimeouts No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

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

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


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | DialogflowAgentTimeouts;