pulumi-gcp-kotlin/com.pulumi.gcp.diagflow.kotlin/CxSecuritySettingsArgs

CxSecuritySettingsArgs

data class CxSecuritySettingsArgs(val audioExportSettings: Output<CxSecuritySettingsAudioExportSettingsArgs>? = null, val deidentifyTemplate: Output<String>? = null, val displayName: Output<String>? = null, val insightsExportSettings: Output<CxSecuritySettingsInsightsExportSettingsArgs>? = null, val inspectTemplate: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val purgeDataTypes: Output<List<String>>? = null, val redactionScope: Output<String>? = null, val redactionStrategy: Output<String>? = null, val retentionStrategy: Output<String>? = null, val retentionWindowDays: Output<Int>? = null) : ConvertibleToJava<CxSecuritySettingsArgs>

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:

Example Usage

Dialogflowcx Security Settings Basic

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,
});
Content copied to clipboard
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)
Content copied to clipboard
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,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
resources:
  basicSecuritySettings:
    type: gcp:diagflow:CxSecuritySettings
    name: basic_security_settings
    properties:
      displayName: dialogflowcx-security-settings
      location: global
      purgeDataTypes: []
      retentionWindowDays: 7
Content copied to clipboard

Dialogflowcx Security Settings Full

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",
});
Content copied to clipboard
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={
        "info_types": [{
            "name": "EMAIL_ADDRESS",
        }],
    })
deidentify = gcp.dataloss.PreventionDeidentifyTemplate("deidentify",
    parent="projects/my-project-name/locations/global",
    display_name="dialogflowcx-deidentify-template",
    deidentify_config={
        "info_type_transformations": {
            "transformations": [{
                "primitive_transformation": {
                    "replace_config": {
                        "new_value": {
                            "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={
        "gcs_bucket": bucket.id,
        "audio_export_pattern": "export",
        "enable_audio_redaction": True,
        "audio_format": "OGG",
    },
    insights_export_settings={
        "enable_insights_export": True,
    },
    retention_strategy="REMOVE_AFTER_CONVERSATION")
Content copied to clipboard
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",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataloss"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/diagflow"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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:

$ pulumi import gcp:diagflow/cxSecuritySettings:CxSecuritySettings default projects/{{project}}/locations/{{location}}/securitySettings/{{name}}
Content copied to clipboard
$ pulumi import gcp:diagflow/cxSecuritySettings:CxSecuritySettings default {{project}}/{{location}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:diagflow/cxSecuritySettings:CxSecuritySettings default {{location}}/{{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(audioExportSettings: Output<CxSecuritySettingsAudioExportSettingsArgs>? = null, deidentifyTemplate: Output<String>? = null, displayName: Output<String>? = null, insightsExportSettings: Output<CxSecuritySettingsInsightsExportSettingsArgs>? = null, inspectTemplate: Output<String>? = null, location: Output<String>? = null, project: Output<String>? = null, purgeDataTypes: Output<List<String>>? = null, redactionScope: Output<String>? = null, redactionStrategy: Output<String>? = null, retentionStrategy: Output<String>? = null, retentionWindowDays: Output<Int>? = null)

Properties

Link copied to clipboard
val audioExportSettings: Output<CxSecuritySettingsAudioExportSettingsArgs>? = null

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. Structure is documented below.

Link copied to clipboard
val deidentifyTemplate: Output<String>? = null

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/