com.pulumi.gcp.diagflow.kotlin.CxSecuritySettingsArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.diagflow.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.diagflow.CxSecuritySettingsArgs.builder
import com.pulumi.gcp.diagflow.kotlin.inputs.CxSecuritySettingsAudioExportSettingsArgs
import com.pulumi.gcp.diagflow.kotlin.inputs.CxSecuritySettingsAudioExportSettingsArgsBuilder
import com.pulumi.gcp.diagflow.kotlin.inputs.CxSecuritySettingsInsightsExportSettingsArgs
import com.pulumi.gcp.diagflow.kotlin.inputs.CxSecuritySettingsInsightsExportSettingsArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.
* Multiple security settings can be configured in each location. Each agent can specify the security settings to apply, and each setting can be applied to multiple agents in the same project and location.
* To get more information about SecuritySettings, see:
* * [API documentation](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.securitySettings)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/dialogflow/cx/docs)
* ## Example Usage
* ### Dialogflowcx Security Settings Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const basicSecuritySettings = new gcp.diagflow.CxSecuritySettings("basic_security_settings", {
* displayName: "dialogflowcx-security-settings",
* location: "global",
* purgeDataTypes: [],
* retentionWindowDays: 7,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* basic_security_settings = gcp.diagflow.CxSecuritySettings("basic_security_settings",
* display_name="dialogflowcx-security-settings",
* location="global",
* purge_data_types=[],
* retention_window_days=7)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var basicSecuritySettings = new Gcp.Diagflow.CxSecuritySettings("basic_security_settings", new()
* {
* DisplayName = "dialogflowcx-security-settings",
* Location = "global",
* PurgeDataTypes = new[] {},
* RetentionWindowDays = 7,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := diagflow.NewCxSecuritySettings(ctx, "basic_security_settings", &diagflow.CxSecuritySettingsArgs{
* DisplayName: pulumi.String("dialogflowcx-security-settings"),
* Location: pulumi.String("global"),
* PurgeDataTypes: pulumi.StringArray{},
* RetentionWindowDays: pulumi.Int(7),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.diagflow.CxSecuritySettings;
* import com.pulumi.gcp.diagflow.CxSecuritySettingsArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var basicSecuritySettings = new CxSecuritySettings("basicSecuritySettings", CxSecuritySettingsArgs.builder()
* .displayName("dialogflowcx-security-settings")
* .location("global")
* .purgeDataTypes()
* .retentionWindowDays(7)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* basicSecuritySettings:
* type: gcp:diagflow:CxSecuritySettings
* name: basic_security_settings
* properties:
* displayName: dialogflowcx-security-settings
* location: global
* purgeDataTypes: []
* retentionWindowDays: 7
* ```
*
* ### Dialogflowcx Security Settings Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const inspect = new gcp.dataloss.PreventionInspectTemplate("inspect", {
* parent: "projects/my-project-name/locations/global",
* displayName: "dialogflowcx-inspect-template",
* inspectConfig: {
* infoTypes: [{
* name: "EMAIL_ADDRESS",
* }],
* },
* });
* const deidentify = new gcp.dataloss.PreventionDeidentifyTemplate("deidentify", {
* parent: "projects/my-project-name/locations/global",
* displayName: "dialogflowcx-deidentify-template",
* deidentifyConfig: {
* infoTypeTransformations: {
* transformations: [{
* primitiveTransformation: {
* replaceConfig: {
* newValue: {
* stringValue: "[REDACTED]",
* },
* },
* },
* }],
* },
* },
* });
* const bucket = new gcp.storage.Bucket("bucket", {
* name: "dialogflowcx-bucket",
* location: "US",
* uniformBucketLevelAccess: true,
* });
* const basicSecuritySettings = new gcp.diagflow.CxSecuritySettings("basic_security_settings", {
* displayName: "dialogflowcx-security-settings",
* location: "global",
* redactionStrategy: "REDACT_WITH_SERVICE",
* redactionScope: "REDACT_DISK_STORAGE",
* inspectTemplate: inspect.id,
* deidentifyTemplate: deidentify.id,
* purgeDataTypes: ["DIALOGFLOW_HISTORY"],
* audioExportSettings: {
* gcsBucket: bucket.id,
* audioExportPattern: "export",
* enableAudioRedaction: true,
* audioFormat: "OGG",
* },
* insightsExportSettings: {
* enableInsightsExport: true,
* },
* retentionStrategy: "REMOVE_AFTER_CONVERSATION",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* inspect = gcp.dataloss.PreventionInspectTemplate("inspect",
* parent="projects/my-project-name/locations/global",
* display_name="dialogflowcx-inspect-template",
* inspect_config=gcp.dataloss.PreventionInspectTemplateInspectConfigArgs(
* info_types=[gcp.dataloss.PreventionInspectTemplateInspectConfigInfoTypeArgs(
* name="EMAIL_ADDRESS",
* )],
* ))
* deidentify = gcp.dataloss.PreventionDeidentifyTemplate("deidentify",
* parent="projects/my-project-name/locations/global",
* display_name="dialogflowcx-deidentify-template",
* deidentify_config=gcp.dataloss.PreventionDeidentifyTemplateDeidentifyConfigArgs(
* info_type_transformations=gcp.dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsArgs(
* transformations=[gcp.dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationArgs(
* primitive_transformation=gcp.dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationArgs(
* replace_config=gcp.dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigArgs(
* new_value=gcp.dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigNewValueArgs(
* string_value="[REDACTED]",
* ),
* ),
* ),
* )],
* ),
* ))
* bucket = gcp.storage.Bucket("bucket",
* name="dialogflowcx-bucket",
* location="US",
* uniform_bucket_level_access=True)
* basic_security_settings = gcp.diagflow.CxSecuritySettings("basic_security_settings",
* display_name="dialogflowcx-security-settings",
* location="global",
* redaction_strategy="REDACT_WITH_SERVICE",
* redaction_scope="REDACT_DISK_STORAGE",
* inspect_template=inspect.id,
* deidentify_template=deidentify.id,
* purge_data_types=["DIALOGFLOW_HISTORY"],
* audio_export_settings=gcp.diagflow.CxSecuritySettingsAudioExportSettingsArgs(
* gcs_bucket=bucket.id,
* audio_export_pattern="export",
* enable_audio_redaction=True,
* audio_format="OGG",
* ),
* insights_export_settings=gcp.diagflow.CxSecuritySettingsInsightsExportSettingsArgs(
* enable_insights_export=True,
* ),
* retention_strategy="REMOVE_AFTER_CONVERSATION")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var inspect = new Gcp.DataLoss.PreventionInspectTemplate("inspect", new()
* {
* Parent = "projects/my-project-name/locations/global",
* DisplayName = "dialogflowcx-inspect-template",
* InspectConfig = new Gcp.DataLoss.Inputs.PreventionInspectTemplateInspectConfigArgs
* {
* InfoTypes = new[]
* {
* new Gcp.DataLoss.Inputs.PreventionInspectTemplateInspectConfigInfoTypeArgs
* {
* Name = "EMAIL_ADDRESS",
* },
* },
* },
* });
* var deidentify = new Gcp.DataLoss.PreventionDeidentifyTemplate("deidentify", new()
* {
* Parent = "projects/my-project-name/locations/global",
* DisplayName = "dialogflowcx-deidentify-template",
* DeidentifyConfig = new Gcp.DataLoss.Inputs.PreventionDeidentifyTemplateDeidentifyConfigArgs
* {
* InfoTypeTransformations = new Gcp.DataLoss.Inputs.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsArgs
* {
* Transformations = new[]
* {
* new Gcp.DataLoss.Inputs.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationArgs
* {
* PrimitiveTransformation = new Gcp.DataLoss.Inputs.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationArgs
* {
* ReplaceConfig = new Gcp.DataLoss.Inputs.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigArgs
* {
* NewValue = new Gcp.DataLoss.Inputs.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigNewValueArgs
* {
* StringValue = "[REDACTED]",
* },
* },
* },
* },
* },
* },
* },
* });
* var bucket = new Gcp.Storage.Bucket("bucket", new()
* {
* Name = "dialogflowcx-bucket",
* Location = "US",
* UniformBucketLevelAccess = true,
* });
* var basicSecuritySettings = new Gcp.Diagflow.CxSecuritySettings("basic_security_settings", new()
* {
* DisplayName = "dialogflowcx-security-settings",
* Location = "global",
* RedactionStrategy = "REDACT_WITH_SERVICE",
* RedactionScope = "REDACT_DISK_STORAGE",
* InspectTemplate = inspect.Id,
* DeidentifyTemplate = deidentify.Id,
* PurgeDataTypes = new[]
* {
* "DIALOGFLOW_HISTORY",
* },
* AudioExportSettings = new Gcp.Diagflow.Inputs.CxSecuritySettingsAudioExportSettingsArgs
* {
* GcsBucket = bucket.Id,
* AudioExportPattern = "export",
* EnableAudioRedaction = true,
* AudioFormat = "OGG",
* },
* InsightsExportSettings = new Gcp.Diagflow.Inputs.CxSecuritySettingsInsightsExportSettingsArgs
* {
* EnableInsightsExport = true,
* },
* RetentionStrategy = "REMOVE_AFTER_CONVERSATION",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataloss"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/diagflow"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/storage"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* inspect, err := dataloss.NewPreventionInspectTemplate(ctx, "inspect", &dataloss.PreventionInspectTemplateArgs{
* Parent: pulumi.String("projects/my-project-name/locations/global"),
* DisplayName: pulumi.String("dialogflowcx-inspect-template"),
* InspectConfig: &dataloss.PreventionInspectTemplateInspectConfigArgs{
* InfoTypes: dataloss.PreventionInspectTemplateInspectConfigInfoTypeArray{
* &dataloss.PreventionInspectTemplateInspectConfigInfoTypeArgs{
* Name: pulumi.String("EMAIL_ADDRESS"),
* },
* },
* },
* })
* if err != nil {
* return err
* }
* deidentify, err := dataloss.NewPreventionDeidentifyTemplate(ctx, "deidentify", &dataloss.PreventionDeidentifyTemplateArgs{
* Parent: pulumi.String("projects/my-project-name/locations/global"),
* DisplayName: pulumi.String("dialogflowcx-deidentify-template"),
* DeidentifyConfig: &dataloss.PreventionDeidentifyTemplateDeidentifyConfigArgs{
* InfoTypeTransformations: &dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsArgs{
* Transformations: dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationArray{
* &dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationArgs{
* PrimitiveTransformation: &dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationArgs{
* ReplaceConfig: &dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigArgs{
* NewValue: &dataloss.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigNewValueArgs{
* StringValue: pulumi.String("[REDACTED]"),
* },
* },
* },
* },
* },
* },
* },
* })
* if err != nil {
* return err
* }
* bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
* Name: pulumi.String("dialogflowcx-bucket"),
* Location: pulumi.String("US"),
* UniformBucketLevelAccess: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* _, err = diagflow.NewCxSecuritySettings(ctx, "basic_security_settings", &diagflow.CxSecuritySettingsArgs{
* DisplayName: pulumi.String("dialogflowcx-security-settings"),
* Location: pulumi.String("global"),
* RedactionStrategy: pulumi.String("REDACT_WITH_SERVICE"),
* RedactionScope: pulumi.String("REDACT_DISK_STORAGE"),
* InspectTemplate: inspect.ID(),
* DeidentifyTemplate: deidentify.ID(),
* PurgeDataTypes: pulumi.StringArray{
* pulumi.String("DIALOGFLOW_HISTORY"),
* },
* AudioExportSettings: &diagflow.CxSecuritySettingsAudioExportSettingsArgs{
* GcsBucket: bucket.ID(),
* AudioExportPattern: pulumi.String("export"),
* EnableAudioRedaction: pulumi.Bool(true),
* AudioFormat: pulumi.String("OGG"),
* },
* InsightsExportSettings: &diagflow.CxSecuritySettingsInsightsExportSettingsArgs{
* EnableInsightsExport: pulumi.Bool(true),
* },
* RetentionStrategy: pulumi.String("REMOVE_AFTER_CONVERSATION"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.dataloss.PreventionInspectTemplate;
* import com.pulumi.gcp.dataloss.PreventionInspectTemplateArgs;
* import com.pulumi.gcp.dataloss.inputs.PreventionInspectTemplateInspectConfigArgs;
* import com.pulumi.gcp.dataloss.PreventionDeidentifyTemplate;
* import com.pulumi.gcp.dataloss.PreventionDeidentifyTemplateArgs;
* import com.pulumi.gcp.dataloss.inputs.PreventionDeidentifyTemplateDeidentifyConfigArgs;
* import com.pulumi.gcp.dataloss.inputs.PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsArgs;
* import com.pulumi.gcp.storage.Bucket;
* import com.pulumi.gcp.storage.BucketArgs;
* import com.pulumi.gcp.diagflow.CxSecuritySettings;
* import com.pulumi.gcp.diagflow.CxSecuritySettingsArgs;
* import com.pulumi.gcp.diagflow.inputs.CxSecuritySettingsAudioExportSettingsArgs;
* import com.pulumi.gcp.diagflow.inputs.CxSecuritySettingsInsightsExportSettingsArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var inspect = new PreventionInspectTemplate("inspect", PreventionInspectTemplateArgs.builder()
* .parent("projects/my-project-name/locations/global")
* .displayName("dialogflowcx-inspect-template")
* .inspectConfig(PreventionInspectTemplateInspectConfigArgs.builder()
* .infoTypes(PreventionInspectTemplateInspectConfigInfoTypeArgs.builder()
* .name("EMAIL_ADDRESS")
* .build())
* .build())
* .build());
* var deidentify = new PreventionDeidentifyTemplate("deidentify", PreventionDeidentifyTemplateArgs.builder()
* .parent("projects/my-project-name/locations/global")
* .displayName("dialogflowcx-deidentify-template")
* .deidentifyConfig(PreventionDeidentifyTemplateDeidentifyConfigArgs.builder()
* .infoTypeTransformations(PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsArgs.builder()
* .transformations(PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationArgs.builder()
* .primitiveTransformation(PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationArgs.builder()
* .replaceConfig(PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigArgs.builder()
* .newValue(PreventionDeidentifyTemplateDeidentifyConfigInfoTypeTransformationsTransformationPrimitiveTransformationReplaceConfigNewValueArgs.builder()
* .stringValue("[REDACTED]")
* .build())
* .build())
* .build())
* .build())
* .build())
* .build())
* .build());
* var bucket = new Bucket("bucket", BucketArgs.builder()
* .name("dialogflowcx-bucket")
* .location("US")
* .uniformBucketLevelAccess(true)
* .build());
* var basicSecuritySettings = new CxSecuritySettings("basicSecuritySettings", CxSecuritySettingsArgs.builder()
* .displayName("dialogflowcx-security-settings")
* .location("global")
* .redactionStrategy("REDACT_WITH_SERVICE")
* .redactionScope("REDACT_DISK_STORAGE")
* .inspectTemplate(inspect.id())
* .deidentifyTemplate(deidentify.id())
* .purgeDataTypes("DIALOGFLOW_HISTORY")
* .audioExportSettings(CxSecuritySettingsAudioExportSettingsArgs.builder()
* .gcsBucket(bucket.id())
* .audioExportPattern("export")
* .enableAudioRedaction(true)
* .audioFormat("OGG")
* .build())
* .insightsExportSettings(CxSecuritySettingsInsightsExportSettingsArgs.builder()
* .enableInsightsExport(true)
* .build())
* .retentionStrategy("REMOVE_AFTER_CONVERSATION")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* inspect:
* type: gcp:dataloss:PreventionInspectTemplate
* properties:
* parent: projects/my-project-name/locations/global
* displayName: dialogflowcx-inspect-template
* inspectConfig:
* infoTypes:
* - name: EMAIL_ADDRESS
* deidentify:
* type: gcp:dataloss:PreventionDeidentifyTemplate
* properties:
* parent: projects/my-project-name/locations/global
* displayName: dialogflowcx-deidentify-template
* deidentifyConfig:
* infoTypeTransformations:
* transformations:
* - primitiveTransformation:
* replaceConfig:
* newValue:
* stringValue: '[REDACTED]'
* bucket:
* type: gcp:storage:Bucket
* properties:
* name: dialogflowcx-bucket
* location: US
* uniformBucketLevelAccess: true
* basicSecuritySettings:
* type: gcp:diagflow:CxSecuritySettings
* name: basic_security_settings
* properties:
* displayName: dialogflowcx-security-settings
* location: global
* redactionStrategy: REDACT_WITH_SERVICE
* redactionScope: REDACT_DISK_STORAGE
* inspectTemplate: ${inspect.id}
* deidentifyTemplate: ${deidentify.id}
* purgeDataTypes:
* - DIALOGFLOW_HISTORY
* audioExportSettings:
* gcsBucket: ${bucket.id}
* audioExportPattern: export
* enableAudioRedaction: true
* audioFormat: OGG
* insightsExportSettings:
* enableInsightsExport: true
* retentionStrategy: REMOVE_AFTER_CONVERSATION
* ```
*
* ## Import
* SecuritySettings can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/securitySettings/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
* When using the `pulumi import` command, SecuritySettings can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:diagflow/cxSecuritySettings:CxSecuritySettings default projects/{{project}}/locations/{{location}}/securitySettings/{{name}}
* ```
* ```sh
* $ pulumi import gcp:diagflow/cxSecuritySettings:CxSecuritySettings default {{project}}/{{location}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:diagflow/cxSecuritySettings:CxSecuritySettings default {{location}}/{{name}}
* ```
* @property audioExportSettings Controls audio export settings for post-conversation analytics when ingesting audio to conversations.
* If retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled.
* If audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket.
* This setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent).
* Structure is documented below.
* @property deidentifyTemplate [DLP](https://cloud.google.com/dlp/docs) 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/
* @property displayName The human-readable name of the security settings, unique within the location.
* - - -
* @property insightsExportSettings Controls conversation exporting settings to Insights after conversation is completed.
* If retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
* Structure is documented below.
* @property inspectTemplate [DLP](https://cloud.google.com/dlp/docs) 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/
* @property location The location these settings are located in. Settings can only be applied to an agent in the same location.
* See [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations.
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property purgeDataTypes List of types of data to remove when retention settings triggers purge.
* Each value may be one of: `DIALOGFLOW_HISTORY`.
* @property redactionScope 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 are: `REDACT_DISK_STORAGE`.
* @property redactionStrategy 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 are: `REDACT_WITH_SERVICE`.
* @property retentionStrategy 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 are: `REMOVE_AFTER_CONVERSATION`.
* @property retentionWindowDays 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.
*/
public data class CxSecuritySettingsArgs(
public val audioExportSettings: Output? = null,
public val deidentifyTemplate: Output? = null,
public val displayName: Output? = null,
public val insightsExportSettings: Output? = null,
public val inspectTemplate: Output? = null,
public val location: Output? = null,
public val project: Output? = null,
public val purgeDataTypes: Output>? = null,
public val redactionScope: Output? = null,
public val redactionStrategy: Output? = null,
public val retentionStrategy: Output? = null,
public val retentionWindowDays: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.diagflow.CxSecuritySettingsArgs =
com.pulumi.gcp.diagflow.CxSecuritySettingsArgs.builder()
.audioExportSettings(
audioExportSettings?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.deidentifyTemplate(deidentifyTemplate?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.insightsExportSettings(
insightsExportSettings?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.inspectTemplate(inspectTemplate?.applyValue({ args0 -> args0 }))
.location(location?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.purgeDataTypes(purgeDataTypes?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.redactionScope(redactionScope?.applyValue({ args0 -> args0 }))
.redactionStrategy(redactionStrategy?.applyValue({ args0 -> args0 }))
.retentionStrategy(retentionStrategy?.applyValue({ args0 -> args0 }))
.retentionWindowDays(retentionWindowDays?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [CxSecuritySettingsArgs].
*/
@PulumiTagMarker
public class CxSecuritySettingsArgsBuilder internal constructor() {
private var audioExportSettings: Output? = null
private var deidentifyTemplate: Output? = null
private var displayName: Output? = null
private var insightsExportSettings: Output? = null
private var inspectTemplate: Output? = null
private var location: Output? = null
private var project: Output? = null
private var purgeDataTypes: Output>? = null
private var redactionScope: Output? = null
private var redactionStrategy: Output? = null
private var retentionStrategy: Output? = null
private var retentionWindowDays: Output? = null
/**
* @param value Controls audio export settings for post-conversation analytics when ingesting audio to conversations.
* If retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled.
* If audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket.
* This setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent).
* Structure is documented below.
*/
@JvmName("qctubqwlmycqiuvo")
public suspend fun audioExportSettings(`value`: Output) {
this.audioExportSettings = value
}
/**
* @param value [DLP](https://cloud.google.com/dlp/docs) 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/
*/
@JvmName("tnsbhuwocafbefym")
public suspend fun deidentifyTemplate(`value`: Output) {
this.deidentifyTemplate = value
}
/**
* @param value The human-readable name of the security settings, unique within the location.
* - - -
*/
@JvmName("mspucujvcmfpcdqh")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value Controls conversation exporting settings to Insights after conversation is completed.
* If retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
* Structure is documented below.
*/
@JvmName("lbfclppesbgfwktb")
public suspend fun insightsExportSettings(`value`: Output) {
this.insightsExportSettings = value
}
/**
* @param value [DLP](https://cloud.google.com/dlp/docs) 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/
*/
@JvmName("jkgwvekseitnfkcf")
public suspend fun inspectTemplate(`value`: Output) {
this.inspectTemplate = value
}
/**
* @param value The location these settings are located in. Settings can only be applied to an agent in the same location.
* See [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations.
*/
@JvmName("bntqvuyaaykjhugd")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("qxfwfsstsmohlsjw")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value List of types of data to remove when retention settings triggers purge.
* Each value may be one of: `DIALOGFLOW_HISTORY`.
*/
@JvmName("sjnwaxrwpjipnxxn")
public suspend fun purgeDataTypes(`value`: Output>) {
this.purgeDataTypes = value
}
@JvmName("ijtctgrgkiibyqdb")
public suspend fun purgeDataTypes(vararg values: Output) {
this.purgeDataTypes = Output.all(values.asList())
}
/**
* @param values List of types of data to remove when retention settings triggers purge.
* Each value may be one of: `DIALOGFLOW_HISTORY`.
*/
@JvmName("hsaqkripficnldge")
public suspend fun purgeDataTypes(values: List>) {
this.purgeDataTypes = Output.all(values)
}
/**
* @param value 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 are: `REDACT_DISK_STORAGE`.
*/
@JvmName("jblbuvefkexuerjb")
public suspend fun redactionScope(`value`: Output) {
this.redactionScope = value
}
/**
* @param value 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 are: `REDACT_WITH_SERVICE`.
*/
@JvmName("nsdfkfgvukfwfgdt")
public suspend fun redactionStrategy(`value`: Output) {
this.redactionStrategy = value
}
/**
* @param value 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 are: `REMOVE_AFTER_CONVERSATION`.
*/
@JvmName("vcfvwknmagcnhtpa")
public suspend fun retentionStrategy(`value`: Output) {
this.retentionStrategy = value
}
/**
* @param value 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.
*/
@JvmName("duumqyemvwslwkpt")
public suspend fun retentionWindowDays(`value`: Output) {
this.retentionWindowDays = value
}
/**
* @param value Controls audio export settings for post-conversation analytics when ingesting audio to conversations.
* If retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled.
* If audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket.
* This setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent).
* Structure is documented below.
*/
@JvmName("jengfhqvvcgarahi")
public suspend fun audioExportSettings(`value`: CxSecuritySettingsAudioExportSettingsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.audioExportSettings = mapped
}
/**
* @param argument Controls audio export settings for post-conversation analytics when ingesting audio to conversations.
* If retention_strategy is set to REMOVE_AFTER_CONVERSATION or gcs_bucket is empty, audio export is disabled.
* If audio export is enabled, audio is recorded and saved to gcs_bucket, subject to retention policy of gcs_bucket.
* This setting won't effect audio input for implicit sessions via [Sessions.DetectIntent](https://cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.sessions/detectIntent#google.cloud.dialogflow.cx.v3.Sessions.DetectIntent).
* Structure is documented below.
*/
@JvmName("mjuwumjrtslykhsd")
public suspend fun audioExportSettings(argument: suspend CxSecuritySettingsAudioExportSettingsArgsBuilder.() -> Unit) {
val toBeMapped = CxSecuritySettingsAudioExportSettingsArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.audioExportSettings = mapped
}
/**
* @param value [DLP](https://cloud.google.com/dlp/docs) 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/
*/
@JvmName("sveisuywswrkcejj")
public suspend fun deidentifyTemplate(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.deidentifyTemplate = mapped
}
/**
* @param value The human-readable name of the security settings, unique within the location.
* - - -
*/
@JvmName("oflcbnbnbpsbvpgp")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value Controls conversation exporting settings to Insights after conversation is completed.
* If retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
* Structure is documented below.
*/
@JvmName("xlbccmujnfkjehmw")
public suspend fun insightsExportSettings(`value`: CxSecuritySettingsInsightsExportSettingsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.insightsExportSettings = mapped
}
/**
* @param argument Controls conversation exporting settings to Insights after conversation is completed.
* If retentionStrategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
* Structure is documented below.
*/
@JvmName("ppflfgwpjpuvchkf")
public suspend fun insightsExportSettings(argument: suspend CxSecuritySettingsInsightsExportSettingsArgsBuilder.() -> Unit) {
val toBeMapped = CxSecuritySettingsInsightsExportSettingsArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.insightsExportSettings = mapped
}
/**
* @param value [DLP](https://cloud.google.com/dlp/docs) 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/
*/
@JvmName("iychskgferyjpxar")
public suspend fun inspectTemplate(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.inspectTemplate = mapped
}
/**
* @param value The location these settings are located in. Settings can only be applied to an agent in the same location.
* See [Available Regions](https://cloud.google.com/dialogflow/cx/docs/concept/region#avail) for a list of supported locations.
*/
@JvmName("vdlfnxaaqcuruepu")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("ndhythdduswvmpvt")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value List of types of data to remove when retention settings triggers purge.
* Each value may be one of: `DIALOGFLOW_HISTORY`.
*/
@JvmName("welqdlohwrdppqia")
public suspend fun purgeDataTypes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.purgeDataTypes = mapped
}
/**
* @param values List of types of data to remove when retention settings triggers purge.
* Each value may be one of: `DIALOGFLOW_HISTORY`.
*/
@JvmName("gedcinadohejitff")
public suspend fun purgeDataTypes(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.purgeDataTypes = mapped
}
/**
* @param value 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 are: `REDACT_DISK_STORAGE`.
*/
@JvmName("uplphsflbbifewsv")
public suspend fun redactionScope(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.redactionScope = mapped
}
/**
* @param value 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 are: `REDACT_WITH_SERVICE`.
*/
@JvmName("lwifwggwprkhpflh")
public suspend fun redactionStrategy(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.redactionStrategy = mapped
}
/**
* @param value 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 are: `REMOVE_AFTER_CONVERSATION`.
*/
@JvmName("vgmvsbkxlxypmffo")
public suspend fun retentionStrategy(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.retentionStrategy = mapped
}
/**
* @param value 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.
*/
@JvmName("udhloqjnlkafswpe")
public suspend fun retentionWindowDays(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.retentionWindowDays = mapped
}
internal fun build(): CxSecuritySettingsArgs = CxSecuritySettingsArgs(
audioExportSettings = audioExportSettings,
deidentifyTemplate = deidentifyTemplate,
displayName = displayName,
insightsExportSettings = insightsExportSettings,
inspectTemplate = inspectTemplate,
location = location,
project = project,
purgeDataTypes = purgeDataTypes,
redactionScope = redactionScope,
redactionStrategy = redactionStrategy,
retentionStrategy = retentionStrategy,
retentionWindowDays = retentionWindowDays,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy