Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3
  6. SecuritySetting

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v3.SecuritySetting

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Create security settings in the specified location.

    Create SecuritySetting Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SecuritySetting(name: string, args: SecuritySettingArgs, opts?: CustomResourceOptions);
    @overload
def SecuritySetting(resource_name: str,
                    args: SecuritySettingArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SecuritySetting(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    display_name: Optional[str] = None,
                    name: Optional[str] = None,
                    deidentify_template: Optional[str] = None,
                    insights_export_settings: Optional[GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs] = None,
                    inspect_template: Optional[str] = None,
                    location: Optional[str] = None,
                    audio_export_settings: Optional[GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs] = None,
                    project: Optional[str] = None,
                    purge_data_types: Optional[Sequence[SecuritySettingPurgeDataTypesItem]] = None,
                    redaction_scope: Optional[SecuritySettingRedactionScope] = None,
                    redaction_strategy: Optional[SecuritySettingRedactionStrategy] = None,
                    retention_strategy: Optional[SecuritySettingRetentionStrategy] = None,
                    retention_window_days: Optional[int] = None)
    func NewSecuritySetting(ctx *Context, name string, args SecuritySettingArgs, opts ...ResourceOption) (*SecuritySetting, error)
    public SecuritySetting(string name, SecuritySettingArgs args, CustomResourceOptions? opts = null)
    public SecuritySetting(String name, SecuritySettingArgs args)
public SecuritySetting(String name, SecuritySettingArgs args, CustomResourceOptions options)

    type: google-native:dialogflow/v3:SecuritySetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SecuritySettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SecuritySettingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SecuritySettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecuritySettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecuritySettingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var securitySettingResource = new GoogleNative.Dialogflow.V3.SecuritySetting("securitySettingResource", new()
{
    DisplayName = "string",
    Name = "string",
    DeidentifyTemplate = "string",
    InsightsExportSettings = new GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs
    {
        EnableInsightsExport = false,
    },
    InspectTemplate = "string",
    Location = "string",
    AudioExportSettings = new GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs
    {
        AudioExportPattern = "string",
        AudioFormat = GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat.AudioFormatUnspecified,
        EnableAudioRedaction = false,
        GcsBucket = "string",
    },
    Project = "string",
    PurgeDataTypes = new[]
    {
        GoogleNative.Dialogflow.V3.SecuritySettingPurgeDataTypesItem.PurgeDataTypeUnspecified,
    },
    RedactionScope = GoogleNative.Dialogflow.V3.SecuritySettingRedactionScope.RedactionScopeUnspecified,
    RedactionStrategy = GoogleNative.Dialogflow.V3.SecuritySettingRedactionStrategy.RedactionStrategyUnspecified,
    RetentionStrategy = GoogleNative.Dialogflow.V3.SecuritySettingRetentionStrategy.RetentionStrategyUnspecified,
    RetentionWindowDays = 0,
});

    example, err := dialogflowv3.NewSecuritySetting(ctx, "securitySettingResource", &dialogflowv3.SecuritySettingArgs{
DisplayName: pulumi.String("string"),
Name: pulumi.String("string"),
DeidentifyTemplate: pulumi.String("string"),
InsightsExportSettings: &dialogflow.GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs{
EnableInsightsExport: pulumi.Bool(false),
},
InspectTemplate: pulumi.String("string"),
Location: pulumi.String("string"),
AudioExportSettings: &dialogflow.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs{
AudioExportPattern: pulumi.String("string"),
AudioFormat: dialogflowv3.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormatAudioFormatUnspecified,
EnableAudioRedaction: pulumi.Bool(false),
GcsBucket: pulumi.String("string"),
},
Project: pulumi.String("string"),
PurgeDataTypes: dialogflow.SecuritySettingPurgeDataTypesItemArray{
dialogflowv3.SecuritySettingPurgeDataTypesItemPurgeDataTypeUnspecified,
},
RedactionScope: dialogflowv3.SecuritySettingRedactionScopeRedactionScopeUnspecified,
RedactionStrategy: dialogflowv3.SecuritySettingRedactionStrategyRedactionStrategyUnspecified,
RetentionStrategy: dialogflowv3.SecuritySettingRetentionStrategyRetentionStrategyUnspecified,
RetentionWindowDays: pulumi.Int(0),
})

    var securitySettingResource = new SecuritySetting("securitySettingResource", SecuritySettingArgs.builder()
    .displayName("string")
    .name("string")
    .deidentifyTemplate("string")
    .insightsExportSettings(GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs.builder()
        .enableInsightsExport(false)
        .build())
    .inspectTemplate("string")
    .location("string")
    .audioExportSettings(GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs.builder()
        .audioExportPattern("string")
        .audioFormat("AUDIO_FORMAT_UNSPECIFIED")
        .enableAudioRedaction(false)
        .gcsBucket("string")
        .build())
    .project("string")
    .purgeDataTypes("PURGE_DATA_TYPE_UNSPECIFIED")
    .redactionScope("REDACTION_SCOPE_UNSPECIFIED")
    .redactionStrategy("REDACTION_STRATEGY_UNSPECIFIED")
    .retentionStrategy("RETENTION_STRATEGY_UNSPECIFIED")
    .retentionWindowDays(0)
    .build());

    security_setting_resource = google_native.dialogflow.v3.SecuritySetting("securitySettingResource",
    display_name="string",
    name="string",
    deidentify_template="string",
    insights_export_settings=google_native.dialogflow.v3.GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs(
        enable_insights_export=False,
    ),
    inspect_template="string",
    location="string",
    audio_export_settings=google_native.dialogflow.v3.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs(
        audio_export_pattern="string",
        audio_format=google_native.dialogflow.v3.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat.AUDIO_FORMAT_UNSPECIFIED,
        enable_audio_redaction=False,
        gcs_bucket="string",
    ),
    project="string",
    purge_data_types=[google_native.dialogflow.v3.SecuritySettingPurgeDataTypesItem.PURGE_DATA_TYPE_UNSPECIFIED],
    redaction_scope=google_native.dialogflow.v3.SecuritySettingRedactionScope.REDACTION_SCOPE_UNSPECIFIED,
    redaction_strategy=google_native.dialogflow.v3.SecuritySettingRedactionStrategy.REDACTION_STRATEGY_UNSPECIFIED,
    retention_strategy=google_native.dialogflow.v3.SecuritySettingRetentionStrategy.RETENTION_STRATEGY_UNSPECIFIED,
    retention_window_days=0)

    const securitySettingResource = new google_native.dialogflow.v3.SecuritySetting("securitySettingResource", {
    displayName: "string",
    name: "string",
    deidentifyTemplate: "string",
    insightsExportSettings: {
        enableInsightsExport: false,
    },
    inspectTemplate: "string",
    location: "string",
    audioExportSettings: {
        audioExportPattern: "string",
        audioFormat: google_native.dialogflow.v3.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat.AudioFormatUnspecified,
        enableAudioRedaction: false,
        gcsBucket: "string",
    },
    project: "string",
    purgeDataTypes: [google_native.dialogflow.v3.SecuritySettingPurgeDataTypesItem.PurgeDataTypeUnspecified],
    redactionScope: google_native.dialogflow.v3.SecuritySettingRedactionScope.RedactionScopeUnspecified,
    redactionStrategy: google_native.dialogflow.v3.SecuritySettingRedactionStrategy.RedactionStrategyUnspecified,
    retentionStrategy: google_native.dialogflow.v3.SecuritySettingRetentionStrategy.RetentionStrategyUnspecified,
    retentionWindowDays: 0,
});

    type: google-native:dialogflow/v3:SecuritySetting
properties:
    audioExportSettings:
        audioExportPattern: string
        audioFormat: AUDIO_FORMAT_UNSPECIFIED
        enableAudioRedaction: false
        gcsBucket: string
    deidentifyTemplate: string
    displayName: string
    insightsExportSettings:
        enableInsightsExport: false
    inspectTemplate: string
    location: string
    name: string
    project: string
    purgeDataTypes:
        - PURGE_DATA_TYPE_UNSPECIFIED
    redactionScope: REDACTION_SCOPE_UNSPECIFIED
    redactionStrategy: REDACTION_STRATEGY_UNSPECIFIED
    retentionStrategy: RETENTION_STRATEGY_UNSPECIFIED
    retentionWindowDays: 0

    SecuritySetting Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SecuritySetting resource accepts the following input properties:

    DisplayName string
    The human-readable name of the security settings, unique within the location.
    AudioExportSettings Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings
    Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
    DeidentifyTemplate string
    DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
    InsightsExportSettings Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings
    Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
    InspectTemplate string
    DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
    Location string
    Name string
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    Project string
    PurgeDataTypes List<Pulumi.GoogleNative.Dialogflow.V3.SecuritySettingPurgeDataTypesItem>
    List of types of data to remove when retention settings triggers purge.
    RedactionScope Pulumi.GoogleNative.Dialogflow.V3.SecuritySettingRedactionScope
    Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
    RedactionStrategy Pulumi.GoogleNative.Dialogflow.V3.SecuritySettingRedactionStrategy
    Strategy that defines how we do redaction.
    RetentionStrategy Pulumi.GoogleNative.Dialogflow.V3.SecuritySettingRetentionStrategy
    Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
    RetentionWindowDays int
    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.
    DisplayName string
    The human-readable name of the security settings, unique within the location.
    AudioExportSettings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs
    Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
    DeidentifyTemplate string
    DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
    InsightsExportSettings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs
    Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
    InspectTemplate string
    DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
    Location string
    Name string
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    Project string
    PurgeDataTypes []SecuritySettingPurgeDataTypesItem
    List of types of data to remove when retention settings triggers purge.
    RedactionScope SecuritySettingRedactionScope
    Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
    RedactionStrategy SecuritySettingRedactionStrategy
    Strategy that defines how we do redaction.
    RetentionStrategy SecuritySettingRetentionStrategy
    Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
    RetentionWindowDays int
    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.
    displayName String
    The human-readable name of the security settings, unique within the location.
    audioExportSettings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings
    Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
    deidentifyTemplate String
    DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
    insightsExportSettings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings
    Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
    inspectTemplate String
    DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
    location String
    name String
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    project String
    purgeDataTypes List<SecuritySettingPurgeDataTypesItem>
    List of types of data to remove when retention settings triggers purge.
    redactionScope SecuritySettingRedactionScope
    Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
    redactionStrategy SecuritySettingRedactionStrategy
    Strategy that defines how we do redaction.
    retentionStrategy SecuritySettingRetentionStrategy
    Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
    retentionWindowDays Integer
    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.
    displayName string
    The human-readable name of the security settings, unique within the location.
    audioExportSettings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings
    Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
    deidentifyTemplate string
    DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
    insightsExportSettings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings
    Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
    inspectTemplate string
    DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
    location string
    name string
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    project string
    purgeDataTypes SecuritySettingPurgeDataTypesItem[]
    List of types of data to remove when retention settings triggers purge.
    redactionScope SecuritySettingRedactionScope
    Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
    redactionStrategy SecuritySettingRedactionStrategy
    Strategy that defines how we do redaction.
    retentionStrategy SecuritySettingRetentionStrategy
    Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
    retentionWindowDays 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.
    display_name str
    The human-readable name of the security settings, unique within the location.
    audio_export_settings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs
    Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
    deidentify_template str
    DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
    insights_export_settings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs
    Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
    inspect_template str
    DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
    location str
    name str
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    project str
    purge_data_types Sequence[SecuritySettingPurgeDataTypesItem]
    List of types of data to remove when retention settings triggers purge.
    redaction_scope SecuritySettingRedactionScope
    Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
    redaction_strategy SecuritySettingRedactionStrategy
    Strategy that defines how we do redaction.
    retention_strategy SecuritySettingRetentionStrategy
    Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
    retention_window_days int
    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.
    displayName String
    The human-readable name of the security settings, unique within the location.
    audioExportSettings Property Map
    Controls audio export settings for post-conversation analytics when ingesting audio to conversations via Participants.AnalyzeContent or Participants.StreamingAnalyzeContent. If retention_strategy is set to REMOVE_AFTER_CONVERSATION or audio_export_settings.gcs_bucket is empty, audio export is disabled. If audio export is enabled, audio is recorded and saved to audio_export_settings.gcs_bucket, subject to retention policy of audio_export_settings.gcs_bucket. This setting won't effect audio input for implicit sessions via Sessions.DetectIntent or Sessions.StreamingDetectIntent.
    deidentifyTemplate String
    DLP deidentify template name. Use this template to define de-identification configuration for the content. The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, Dialogflow replaces sensitive info with [redacted] text. The template name will have one of the following formats: projects//locations//deidentifyTemplates/ OR organizations//locations//deidentifyTemplates/ Note: deidentify_template must be located in the same region as the SecuritySettings.
    insightsExportSettings Property Map
    Controls conversation exporting settings to Insights after conversation is completed. If retention_strategy is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.
    inspectTemplate String
    DLP inspect template name. Use this template to define inspect base settings. The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: projects//locations//inspectTemplates/ OR organizations//locations//inspectTemplates/ Note: inspect_template must be located in the same region as the SecuritySettings.
    location String
    name String
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    project String
    purgeDataTypes List<"PURGE_DATA_TYPE_UNSPECIFIED" | "DIALOGFLOW_HISTORY">
    List of types of data to remove when retention settings triggers purge.
    redactionScope "REDACTION_SCOPE_UNSPECIFIED" | "REDACT_DISK_STORAGE"
    Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.
    redactionStrategy "REDACTION_STRATEGY_UNSPECIFIED" | "REDACT_WITH_SERVICE"
    Strategy that defines how we do redaction.
    retentionStrategy "RETENTION_STRATEGY_UNSPECIFIED" | "REMOVE_AFTER_CONVERSATION"
    Specifies the retention behavior defined by SecuritySettings.RetentionStrategy.
    retentionWindowDays 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SecuritySetting resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings, GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsArgs

    AudioExportPattern string
    Filename pattern for exported audio.
    AudioFormat Pulumi.GoogleNative.Dialogflow.V3.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat
    File format for exported audio file. Currently only in telephony recordings.
    EnableAudioRedaction bool
    Enable audio redaction if it is true.
    GcsBucket 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.
    AudioExportPattern string
    Filename pattern for exported audio.
    AudioFormat GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat
    File format for exported audio file. Currently only in telephony recordings.
    EnableAudioRedaction bool
    Enable audio redaction if it is true.
    GcsBucket 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.
    audioExportPattern String
    Filename pattern for exported audio.
    audioFormat GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat
    File format for exported audio file. Currently only in telephony recordings.
    enableAudioRedaction Boolean
    Enable audio redaction if it is true.
    gcsBucket 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.
    audioExportPattern string
    Filename pattern for exported audio.
    audioFormat GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat
    File format for exported audio file. Currently only in telephony recordings.
    enableAudioRedaction boolean
    Enable audio redaction if it is true.
    gcsBucket 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.
    audio_export_pattern str
    Filename pattern for exported audio.
    audio_format GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat
    File format for exported audio file. Currently only in telephony recordings.
    enable_audio_redaction bool
    Enable audio redaction if it is true.
    gcs_bucket str
    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.
    audioExportPattern String
    Filename pattern for exported audio.
    audioFormat "AUDIO_FORMAT_UNSPECIFIED" | "MULAW" | "MP3" | "OGG"
    File format for exported audio file. Currently only in telephony recordings.
    enableAudioRedaction Boolean
    Enable audio redaction if it is true.
    gcsBucket 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.

    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormat, GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormatArgs

    AudioFormatUnspecified
    AUDIO_FORMAT_UNSPECIFIEDUnspecified. Do not use.
    Mulaw
    MULAWG.711 mu-law PCM with 8kHz sample rate.
    Mp3
    MP3MP3 file format.
    Ogg
    OGGOGG Vorbis.
    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormatAudioFormatUnspecified
    AUDIO_FORMAT_UNSPECIFIEDUnspecified. Do not use.
    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormatMulaw
    MULAWG.711 mu-law PCM with 8kHz sample rate.
    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormatMp3
    MP3MP3 file format.
    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsAudioFormatOgg
    OGGOGG Vorbis.
    AudioFormatUnspecified
    AUDIO_FORMAT_UNSPECIFIEDUnspecified. Do not use.
    Mulaw
    MULAWG.711 mu-law PCM with 8kHz sample rate.
    Mp3
    MP3MP3 file format.
    Ogg
    OGGOGG Vorbis.
    AudioFormatUnspecified
    AUDIO_FORMAT_UNSPECIFIEDUnspecified. Do not use.
    Mulaw
    MULAWG.711 mu-law PCM with 8kHz sample rate.
    Mp3
    MP3MP3 file format.
    Ogg
    OGGOGG Vorbis.
    AUDIO_FORMAT_UNSPECIFIED
    AUDIO_FORMAT_UNSPECIFIEDUnspecified. Do not use.
    MULAW
    MULAWG.711 mu-law PCM with 8kHz sample rate.
    MP3
    MP3MP3 file format.
    OGG
    OGGOGG Vorbis.
    "AUDIO_FORMAT_UNSPECIFIED"
    AUDIO_FORMAT_UNSPECIFIEDUnspecified. Do not use.
    "MULAW"
    MULAWG.711 mu-law PCM with 8kHz sample rate.
    "MP3"
    MP3MP3 file format.
    "OGG"
    OGGOGG Vorbis.

    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse, GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponseArgs

    AudioExportPattern string
    Filename pattern for exported audio.
    AudioFormat string
    File format for exported audio file. Currently only in telephony recordings.
    EnableAudioRedaction bool
    Enable audio redaction if it is true.
    GcsBucket 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.
    AudioExportPattern string
    Filename pattern for exported audio.
    AudioFormat string
    File format for exported audio file. Currently only in telephony recordings.
    EnableAudioRedaction bool
    Enable audio redaction if it is true.
    GcsBucket 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.
    audioExportPattern String
    Filename pattern for exported audio.
    audioFormat String
    File format for exported audio file. Currently only in telephony recordings.
    enableAudioRedaction Boolean
    Enable audio redaction if it is true.
    gcsBucket 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.
    audioExportPattern string
    Filename pattern for exported audio.
    audioFormat string
    File format for exported audio file. Currently only in telephony recordings.
    enableAudioRedaction boolean
    Enable audio redaction if it is true.
    gcsBucket 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.
    audio_export_pattern str
    Filename pattern for exported audio.
    audio_format str
    File format for exported audio file. Currently only in telephony recordings.
    enable_audio_redaction bool
    Enable audio redaction if it is true.
    gcs_bucket str
    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.
    audioExportPattern String
    Filename pattern for exported audio.
    audioFormat String
    File format for exported audio file. Currently only in telephony recordings.
    enableAudioRedaction Boolean
    Enable audio redaction if it is true.
    gcsBucket 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.

    GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings, GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsArgs

    EnableInsightsExport bool
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    EnableInsightsExport bool
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enableInsightsExport Boolean
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enableInsightsExport boolean
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enable_insights_export bool
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enableInsightsExport Boolean
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.

    GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse, GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponseArgs

    EnableInsightsExport bool
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    EnableInsightsExport bool
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enableInsightsExport Boolean
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enableInsightsExport boolean
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enable_insights_export bool
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.
    enableInsightsExport Boolean
    If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.

    SecuritySettingPurgeDataTypesItem, SecuritySettingPurgeDataTypesItemArgs

    PurgeDataTypeUnspecified
    PURGE_DATA_TYPE_UNSPECIFIEDUnspecified. Do not use.
    DialogflowHistory
    DIALOGFLOW_HISTORYDialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.
    SecuritySettingPurgeDataTypesItemPurgeDataTypeUnspecified
    PURGE_DATA_TYPE_UNSPECIFIEDUnspecified. Do not use.
    SecuritySettingPurgeDataTypesItemDialogflowHistory
    DIALOGFLOW_HISTORYDialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.
    PurgeDataTypeUnspecified
    PURGE_DATA_TYPE_UNSPECIFIEDUnspecified. Do not use.
    DialogflowHistory
    DIALOGFLOW_HISTORYDialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.
    PurgeDataTypeUnspecified
    PURGE_DATA_TYPE_UNSPECIFIEDUnspecified. Do not use.
    DialogflowHistory
    DIALOGFLOW_HISTORYDialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.
    PURGE_DATA_TYPE_UNSPECIFIED
    PURGE_DATA_TYPE_UNSPECIFIEDUnspecified. Do not use.
    DIALOGFLOW_HISTORY
    DIALOGFLOW_HISTORYDialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.
    "PURGE_DATA_TYPE_UNSPECIFIED"
    PURGE_DATA_TYPE_UNSPECIFIEDUnspecified. Do not use.
    "DIALOGFLOW_HISTORY"
    DIALOGFLOW_HISTORYDialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.

    SecuritySettingRedactionScope, SecuritySettingRedactionScopeArgs

    RedactionScopeUnspecified
    REDACTION_SCOPE_UNSPECIFIEDDon't redact any kind of data.
    RedactDiskStorage
    REDACT_DISK_STORAGEOn 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.
    SecuritySettingRedactionScopeRedactionScopeUnspecified
    REDACTION_SCOPE_UNSPECIFIEDDon't redact any kind of data.
    SecuritySettingRedactionScopeRedactDiskStorage
    REDACT_DISK_STORAGEOn 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.
    RedactionScopeUnspecified
    REDACTION_SCOPE_UNSPECIFIEDDon't redact any kind of data.
    RedactDiskStorage
    REDACT_DISK_STORAGEOn 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.
    RedactionScopeUnspecified
    REDACTION_SCOPE_UNSPECIFIEDDon't redact any kind of data.
    RedactDiskStorage
    REDACT_DISK_STORAGEOn 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.
    REDACTION_SCOPE_UNSPECIFIED
    REDACTION_SCOPE_UNSPECIFIEDDon't redact any kind of data.
    REDACT_DISK_STORAGE
    REDACT_DISK_STORAGEOn 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.
    "REDACTION_SCOPE_UNSPECIFIED"
    REDACTION_SCOPE_UNSPECIFIEDDon't redact any kind of data.
    "REDACT_DISK_STORAGE"
    REDACT_DISK_STORAGEOn 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.

    SecuritySettingRedactionStrategy, SecuritySettingRedactionStrategyArgs

    RedactionStrategyUnspecified
    REDACTION_STRATEGY_UNSPECIFIEDDo not redact.
    RedactWithService
    REDACT_WITH_SERVICECall redaction service to clean up the data to be persisted.
    SecuritySettingRedactionStrategyRedactionStrategyUnspecified
    REDACTION_STRATEGY_UNSPECIFIEDDo not redact.
    SecuritySettingRedactionStrategyRedactWithService
    REDACT_WITH_SERVICECall redaction service to clean up the data to be persisted.
    RedactionStrategyUnspecified
    REDACTION_STRATEGY_UNSPECIFIEDDo not redact.
    RedactWithService
    REDACT_WITH_SERVICECall redaction service to clean up the data to be persisted.
    RedactionStrategyUnspecified
    REDACTION_STRATEGY_UNSPECIFIEDDo not redact.
    RedactWithService
    REDACT_WITH_SERVICECall redaction service to clean up the data to be persisted.
    REDACTION_STRATEGY_UNSPECIFIED
    REDACTION_STRATEGY_UNSPECIFIEDDo not redact.
    REDACT_WITH_SERVICE
    REDACT_WITH_SERVICECall redaction service to clean up the data to be persisted.
    "REDACTION_STRATEGY_UNSPECIFIED"
    REDACTION_STRATEGY_UNSPECIFIEDDo not redact.
    "REDACT_WITH_SERVICE"
    REDACT_WITH_SERVICECall redaction service to clean up the data to be persisted.

    SecuritySettingRetentionStrategy, SecuritySettingRetentionStrategyArgs

    RetentionStrategyUnspecified
    RETENTION_STRATEGY_UNSPECIFIEDRetains the persisted data with Dialogflow's internal default 365d TTLs.
    RemoveAfterConversation
    REMOVE_AFTER_CONVERSATIONRemoves data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends.
    SecuritySettingRetentionStrategyRetentionStrategyUnspecified
    RETENTION_STRATEGY_UNSPECIFIEDRetains the persisted data with Dialogflow's internal default 365d TTLs.
    SecuritySettingRetentionStrategyRemoveAfterConversation
    REMOVE_AFTER_CONVERSATIONRemoves data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends.
    RetentionStrategyUnspecified
    RETENTION_STRATEGY_UNSPECIFIEDRetains the persisted data with Dialogflow's internal default 365d TTLs.
    RemoveAfterConversation
    REMOVE_AFTER_CONVERSATIONRemoves data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends.
    RetentionStrategyUnspecified
    RETENTION_STRATEGY_UNSPECIFIEDRetains the persisted data with Dialogflow's internal default 365d TTLs.
    RemoveAfterConversation
    REMOVE_AFTER_CONVERSATIONRemoves data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends.
    RETENTION_STRATEGY_UNSPECIFIED
    RETENTION_STRATEGY_UNSPECIFIEDRetains the persisted data with Dialogflow's internal default 365d TTLs.
    REMOVE_AFTER_CONVERSATION
    REMOVE_AFTER_CONVERSATIONRemoves data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends.
    "RETENTION_STRATEGY_UNSPECIFIED"
    RETENTION_STRATEGY_UNSPECIFIEDRetains the persisted data with Dialogflow's internal default 365d TTLs.
    "REMOVE_AFTER_CONVERSATION"
    REMOVE_AFTER_CONVERSATIONRemoves data when the conversation ends. If there is no Conversation explicitly established, a default conversation ends when the corresponding Dialogflow session ends.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native