Skip to content

Latest commit

 

History

History
2571 lines (1592 loc) · 142 KB

googleDialogflowCxSecuritySettings.typescript.md

File metadata and controls

2571 lines (1592 loc) · 142 KB

googleDialogflowCxSecuritySettings Submodule

Constructs

GoogleDialogflowCxSecuritySettings

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings google_dialogflow_cx_security_settings}.

Initializers

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

new googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettings(scope: Construct, id: string, config: GoogleDialogflowCxSecuritySettingsConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleDialogflowCxSecuritySettingsConfig 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".
putAudioExportSettings No description.
putInsightsExportSettings No description.
putTimeouts No description.
resetAudioExportSettings No description.
resetDeidentifyTemplate No description.
resetId No description.
resetInsightsExportSettings No description.
resetInspectTemplate No description.
resetProject No description.
resetPurgeDataTypes No description.
resetRedactionScope No description.
resetRedactionStrategy No description.
resetRetentionStrategy No description.
resetRetentionWindowDays 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".


putAudioExportSettings
public putAudioExportSettings(value: GoogleDialogflowCxSecuritySettingsAudioExportSettings): void
valueRequired

putInsightsExportSettings
public putInsightsExportSettings(value: GoogleDialogflowCxSecuritySettingsInsightsExportSettings): void
valueRequired

putTimeouts
public putTimeouts(value: GoogleDialogflowCxSecuritySettingsTimeouts): void
valueRequired

resetAudioExportSettings
public resetAudioExportSettings(): void
resetDeidentifyTemplate
public resetDeidentifyTemplate(): void
resetId
public resetId(): void
resetInsightsExportSettings
public resetInsightsExportSettings(): void
resetInspectTemplate
public resetInspectTemplate(): void
resetProject
public resetProject(): void
resetPurgeDataTypes
public resetPurgeDataTypes(): void
resetRedactionScope
public resetRedactionScope(): void
resetRedactionStrategy
public resetRedactionStrategy(): void
resetRetentionStrategy
public resetRetentionStrategy(): void
resetRetentionWindowDays
public resetRetentionWindowDays(): 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 GoogleDialogflowCxSecuritySettings resource upon running "cdktf plan ".

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

googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettings.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 { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettings.isTerraformElement(x: any)
xRequired
  • Type: any

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

googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettings.isTerraformResource(x: any)
xRequired
  • Type: any

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

googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettings.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing GoogleDialogflowCxSecuritySettings that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#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 GoogleDialogflowCxSecuritySettings 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.
audioExportSettings GoogleDialogflowCxSecuritySettingsAudioExportSettingsOutputReference No description.
insightsExportSettings GoogleDialogflowCxSecuritySettingsInsightsExportSettingsOutputReference No description.
name string No description.
timeouts GoogleDialogflowCxSecuritySettingsTimeoutsOutputReference No description.
audioExportSettingsInput GoogleDialogflowCxSecuritySettingsAudioExportSettings No description.
deidentifyTemplateInput string No description.
displayNameInput string No description.
idInput string No description.
insightsExportSettingsInput GoogleDialogflowCxSecuritySettingsInsightsExportSettings No description.
inspectTemplateInput string No description.
locationInput string No description.
projectInput string No description.
purgeDataTypesInput string[] No description.
redactionScopeInput string No description.
redactionStrategyInput string No description.
retentionStrategyInput string No description.
retentionWindowDaysInput number No description.
timeoutsInput cdktf.IResolvable | GoogleDialogflowCxSecuritySettingsTimeouts No description.
deidentifyTemplate string No description.
displayName string No description.
id string No description.
inspectTemplate string No description.
location string No description.
project string No description.
purgeDataTypes string[] No description.
redactionScope string No description.
redactionStrategy string No description.
retentionStrategy string No description.
retentionWindowDays number 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[]

audioExportSettingsRequired
public readonly audioExportSettings: GoogleDialogflowCxSecuritySettingsAudioExportSettingsOutputReference;

insightsExportSettingsRequired
public readonly insightsExportSettings: GoogleDialogflowCxSecuritySettingsInsightsExportSettingsOutputReference;

nameRequired
public readonly name: string;
  • Type: string

timeoutsRequired
public readonly timeouts: GoogleDialogflowCxSecuritySettingsTimeoutsOutputReference;

audioExportSettingsInputOptional
public readonly audioExportSettingsInput: GoogleDialogflowCxSecuritySettingsAudioExportSettings;

deidentifyTemplateInputOptional
public readonly deidentifyTemplateInput: string;
  • Type: string

displayNameInputOptional
public readonly displayNameInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

insightsExportSettingsInputOptional
public readonly insightsExportSettingsInput: GoogleDialogflowCxSecuritySettingsInsightsExportSettings;

inspectTemplateInputOptional
public readonly inspectTemplateInput: string;
  • Type: string

locationInputOptional
public readonly locationInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

purgeDataTypesInputOptional
public readonly purgeDataTypesInput: string[];
  • Type: string[]

redactionScopeInputOptional
public readonly redactionScopeInput: string;
  • Type: string

redactionStrategyInputOptional
public readonly redactionStrategyInput: string;
  • Type: string

retentionStrategyInputOptional
public readonly retentionStrategyInput: string;
  • Type: string

retentionWindowDaysInputOptional
public readonly retentionWindowDaysInput: number;
  • Type: number

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleDialogflowCxSecuritySettingsTimeouts;

deidentifyTemplateRequired
public readonly deidentifyTemplate: string;
  • Type: string

displayNameRequired
public readonly displayName: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

inspectTemplateRequired
public readonly inspectTemplate: string;
  • Type: string

locationRequired
public readonly location: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

purgeDataTypesRequired
public readonly purgeDataTypes: string[];
  • Type: string[]

redactionScopeRequired
public readonly redactionScope: string;
  • Type: string

redactionStrategyRequired
public readonly redactionStrategy: string;
  • Type: string

retentionStrategyRequired
public readonly retentionStrategy: string;
  • Type: string

retentionWindowDaysRequired
public readonly retentionWindowDays: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleDialogflowCxSecuritySettingsAudioExportSettings

Initializer

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

const googleDialogflowCxSecuritySettingsAudioExportSettings: googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsAudioExportSettings = { ... }

Properties

Name Type Description
audioExportPattern string Filename pattern for exported audio.
audioFormat string File format for exported audio file.
enableAudioRedaction boolean | cdktf.IResolvable Enable audio redaction if it is true.
gcsBucket string Cloud Storage bucket to export audio record to.

audioExportPatternOptional
public readonly audioExportPattern: string;
  • Type: string

Filename pattern for exported audio.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#audio_export_pattern GoogleDialogflowCxSecuritySettings#audio_export_pattern}


audioFormatOptional
public readonly audioFormat: string;
  • Type: string

File format for exported audio file.

Currently only in telephony recordings.

  • MULAW: G.711 mu-law PCM with 8kHz sample rate.
  • MP3: MP3 file format.
  • OGG: OGG Vorbis. Possible values: ["MULAW", "MP3", "OGG"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#audio_format GoogleDialogflowCxSecuritySettings#audio_format}


enableAudioRedactionOptional
public readonly enableAudioRedaction: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Enable audio redaction if it is true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#enable_audio_redaction GoogleDialogflowCxSecuritySettings#enable_audio_redaction}


gcsBucketOptional
public readonly gcsBucket: string;
  • Type: string

Cloud Storage bucket to export audio record to.

Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#gcs_bucket GoogleDialogflowCxSecuritySettings#gcs_bucket}


GoogleDialogflowCxSecuritySettingsConfig

Initializer

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

const googleDialogflowCxSecuritySettingsConfig: googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsConfig = { ... }

Properties


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[]

displayNameRequired
public readonly displayName: string;
  • Type: string

The human-readable name of the security settings, unique within the location.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#display_name GoogleDialogflowCxSecuritySettings#display_name}


locationRequired
public readonly location: string;
  • Type: string

The location these settings are located in.

Settings can only be applied to an agent in the same location. See Available Regions for a list of supported locations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#location GoogleDialogflowCxSecuritySettings#location}


audioExportSettingsOptional
public readonly audioExportSettings: GoogleDialogflowCxSecuritySettingsAudioExportSettings;

audio_export_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#audio_export_settings GoogleDialogflowCxSecuritySettings#audio_export_settings}


deidentifyTemplateOptional
public readonly deidentifyTemplate: string;
  • Type: string

DLP deidentify template name. Use this template to define de-identification configuration for the content. If empty, Dialogflow replaces sensitive info with [redacted] text. Note: deidentifyTemplate must be located in the same region as the SecuritySettings. Format: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#deidentify_template GoogleDialogflowCxSecuritySettings#deidentify_template}


idOptional
public readonly id: string;
  • Type: string

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


insightsExportSettingsOptional
public readonly insightsExportSettings: GoogleDialogflowCxSecuritySettingsInsightsExportSettings;

insights_export_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#insights_export_settings GoogleDialogflowCxSecuritySettings#insights_export_settings}


inspectTemplateOptional
public readonly inspectTemplate: string;
  • Type: string

DLP inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. Note: inspectTemplate must be located in the same region as the SecuritySettings. Format: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#inspect_template GoogleDialogflowCxSecuritySettings#inspect_template}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#project GoogleDialogflowCxSecuritySettings#project}.


purgeDataTypesOptional
public readonly purgeDataTypes: string[];
  • Type: string[]

List of types of data to remove when retention settings triggers purge. Possible values: ["DIALOGFLOW_HISTORY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#purge_data_types GoogleDialogflowCxSecuritySettings#purge_data_types}


redactionScopeOptional
public readonly redactionScope: string;
  • Type: string

Defines what types of data to redact.

If not set, defaults to not redacting any kind of data.

  • REDACT_DISK_STORAGE: On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk. Possible values: ["REDACT_DISK_STORAGE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#redaction_scope GoogleDialogflowCxSecuritySettings#redaction_scope}


redactionStrategyOptional
public readonly redactionStrategy: string;
  • Type: string

Defines how we redact data.

If not set, defaults to not redacting.

  • REDACT_WITH_SERVICE: Call redaction service to clean up the data to be persisted. Possible values: ["REDACT_WITH_SERVICE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#redaction_strategy GoogleDialogflowCxSecuritySettings#redaction_strategy}


retentionStrategyOptional
public readonly retentionStrategy: string;
  • Type: string

Defines how long we retain persisted data that contains sensitive info.

Only one of 'retention_window_days' and 'retention_strategy' may be set.

  • REMOVE_AFTER_CONVERSATION: Removes data when the conversation ends. If there is no conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends. Possible values: ["REMOVE_AFTER_CONVERSATION"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#retention_strategy GoogleDialogflowCxSecuritySettings#retention_strategy}


retentionWindowDaysOptional
public readonly retentionWindowDays: number;
  • Type: number

Retains the data for the specified number of days.

User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. Only one of 'retention_window_days' and 'retention_strategy' may be set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#retention_window_days GoogleDialogflowCxSecuritySettings#retention_window_days}


timeoutsOptional
public readonly timeouts: GoogleDialogflowCxSecuritySettingsTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#timeouts GoogleDialogflowCxSecuritySettings#timeouts}


GoogleDialogflowCxSecuritySettingsInsightsExportSettings

Initializer

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

const googleDialogflowCxSecuritySettingsInsightsExportSettings: googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsInsightsExportSettings = { ... }

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.
displayName string The human-readable name of the security settings, unique within the location.
location string The location these settings are located in.
audioExportSettings GoogleDialogflowCxSecuritySettingsAudioExportSettings audio_export_settings block.
deidentifyTemplate string DLP deidentify template name. Use this template to define de-identification configuration for the content. If empty, Dialogflow replaces sensitive info with [redacted] text. Note: deidentifyTemplate must be located in the same region as the SecuritySettings. Format: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#id GoogleDialogflowCxSecuritySettings#id}.
insightsExportSettings GoogleDialogflowCxSecuritySettingsInsightsExportSettings insights_export_settings block.
inspectTemplate string DLP inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. Note: inspectTemplate must be located in the same region as the SecuritySettings. Format: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#project GoogleDialogflowCxSecuritySettings#project}.
purgeDataTypes string[] List of types of data to remove when retention settings triggers purge. Possible values: ["DIALOGFLOW_HISTORY"].
redactionScope string Defines what types of data to redact.
redactionStrategy string Defines how we redact data.
retentionStrategy string Defines how long we retain persisted data that contains sensitive info.
retentionWindowDays number Retains the data for the specified number of days.
timeouts GoogleDialogflowCxSecuritySettingsTimeouts timeouts block.
Name Type Description
enableInsightsExport boolean | cdktf.IResolvable If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.

enableInsightsExportRequired
public readonly enableInsightsExport: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#enable_insights_export GoogleDialogflowCxSecuritySettings#enable_insights_export}


GoogleDialogflowCxSecuritySettingsTimeouts

Initializer

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

const googleDialogflowCxSecuritySettingsTimeouts: googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#create GoogleDialogflowCxSecuritySettings#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#delete GoogleDialogflowCxSecuritySettings#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#update GoogleDialogflowCxSecuritySettings#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#create GoogleDialogflowCxSecuritySettings#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#delete GoogleDialogflowCxSecuritySettings#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_dialogflow_cx_security_settings#update GoogleDialogflowCxSecuritySettings#update}.


Classes

GoogleDialogflowCxSecuritySettingsAudioExportSettingsOutputReference

Initializers

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

new googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsAudioExportSettingsOutputReference(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.
resetAudioExportPattern No description.
resetAudioFormat No description.
resetEnableAudioRedaction No description.
resetGcsBucket 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.

resetAudioExportPattern
public resetAudioExportPattern(): void
resetAudioFormat
public resetAudioFormat(): void
resetEnableAudioRedaction
public resetEnableAudioRedaction(): void
resetGcsBucket
public resetGcsBucket(): 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.
audioExportPatternInput string No description.
audioFormatInput string No description.
enableAudioRedactionInput boolean | cdktf.IResolvable No description.
gcsBucketInput string No description.
audioExportPattern string No description.
audioFormat string No description.
enableAudioRedaction boolean | cdktf.IResolvable No description.
gcsBucket string No description.
internalValue GoogleDialogflowCxSecuritySettingsAudioExportSettings 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

audioExportPatternInputOptional
public readonly audioExportPatternInput: string;
  • Type: string

audioFormatInputOptional
public readonly audioFormatInput: string;
  • Type: string

enableAudioRedactionInputOptional
public readonly enableAudioRedactionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gcsBucketInputOptional
public readonly gcsBucketInput: string;
  • Type: string

audioExportPatternRequired
public readonly audioExportPattern: string;
  • Type: string

audioFormatRequired
public readonly audioFormat: string;
  • Type: string

enableAudioRedactionRequired
public readonly enableAudioRedaction: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

gcsBucketRequired
public readonly gcsBucket: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleDialogflowCxSecuritySettingsAudioExportSettings;

GoogleDialogflowCxSecuritySettingsInsightsExportSettingsOutputReference

Initializers

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

new googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsInsightsExportSettingsOutputReference(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.

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

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

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

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

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

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

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

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

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

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

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
enableInsightsExportInput boolean | cdktf.IResolvable No description.
enableInsightsExport boolean | cdktf.IResolvable No description.
internalValue GoogleDialogflowCxSecuritySettingsInsightsExportSettings 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

enableInsightsExportInputOptional
public readonly enableInsightsExportInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableInsightsExportRequired
public readonly enableInsightsExport: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

internalValueOptional
public readonly internalValue: GoogleDialogflowCxSecuritySettingsInsightsExportSettings;

GoogleDialogflowCxSecuritySettingsTimeoutsOutputReference

Initializers

import { googleDialogflowCxSecuritySettings } from '@cdktf/provider-google-beta'

new googleDialogflowCxSecuritySettings.GoogleDialogflowCxSecuritySettingsTimeoutsOutputReference(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 | GoogleDialogflowCxSecuritySettingsTimeouts 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 | GoogleDialogflowCxSecuritySettingsTimeouts;