Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3
  6. getSecuritySetting

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.getSecuritySetting

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

    Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

    Using getSecuritySetting

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSecuritySetting(args: GetSecuritySettingArgs, opts?: InvokeOptions): Promise<GetSecuritySettingResult>
function getSecuritySettingOutput(args: GetSecuritySettingOutputArgs, opts?: InvokeOptions): Output<GetSecuritySettingResult>
    def get_security_setting(location: Optional[str] = None,
                         project: Optional[str] = None,
                         security_setting_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSecuritySettingResult
def get_security_setting_output(location: Optional[pulumi.Input[str]] = None,
                         project: Optional[pulumi.Input[str]] = None,
                         security_setting_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSecuritySettingResult]
    func LookupSecuritySetting(ctx *Context, args *LookupSecuritySettingArgs, opts ...InvokeOption) (*LookupSecuritySettingResult, error)
func LookupSecuritySettingOutput(ctx *Context, args *LookupSecuritySettingOutputArgs, opts ...InvokeOption) LookupSecuritySettingResultOutput

    > Note: This function is named LookupSecuritySetting in the Go SDK.

    public static class GetSecuritySetting 
{
    public static Task<GetSecuritySettingResult> InvokeAsync(GetSecuritySettingArgs args, InvokeOptions? opts = null)
    public static Output<GetSecuritySettingResult> Invoke(GetSecuritySettingInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSecuritySettingResult> getSecuritySetting(GetSecuritySettingArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:dialogflow/v3:getSecuritySetting
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getSecuritySetting Result

    The following output properties are available:

    AudioExportSettings Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse
    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.
    DisplayName string
    The human-readable name of the security settings, unique within the location.
    InsightsExportSettings Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse
    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.
    Name string
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    PurgeDataTypes List<string>
    List of types of data to remove when retention settings triggers purge.
    RedactionScope string
    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 string
    Strategy that defines how we do redaction.
    RetentionStrategy string
    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.
    AudioExportSettings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse
    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.
    DisplayName string
    The human-readable name of the security settings, unique within the location.
    InsightsExportSettings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse
    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.
    Name string
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    PurgeDataTypes []string
    List of types of data to remove when retention settings triggers purge.
    RedactionScope string
    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 string
    Strategy that defines how we do redaction.
    RetentionStrategy string
    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.
    audioExportSettings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse
    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.
    displayName String
    The human-readable name of the security settings, unique within the location.
    insightsExportSettings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse
    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.
    name String
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    purgeDataTypes List<String>
    List of types of data to remove when retention settings triggers purge.
    redactionScope String
    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 String
    Strategy that defines how we do redaction.
    retentionStrategy String
    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.
    audioExportSettings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse
    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.
    displayName string
    The human-readable name of the security settings, unique within the location.
    insightsExportSettings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse
    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.
    name string
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    purgeDataTypes string[]
    List of types of data to remove when retention settings triggers purge.
    redactionScope string
    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 string
    Strategy that defines how we do redaction.
    retentionStrategy string
    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.
    audio_export_settings GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse
    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.
    display_name str
    The human-readable name of the security settings, unique within the location.
    insights_export_settings GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse
    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.
    name str
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    purge_data_types Sequence[str]
    List of types of data to remove when retention settings triggers purge.
    redaction_scope str
    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 str
    Strategy that defines how we do redaction.
    retention_strategy str
    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.
    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.
    displayName String
    The human-readable name of the security settings, unique within the location.
    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.
    name String
    Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.
    purgeDataTypes List<String>
    List of types of data to remove when retention settings triggers purge.
    redactionScope String
    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 String
    Strategy that defines how we do redaction.
    retentionStrategy String
    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.

    Supporting Types

    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettingsResponse

    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.

    GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettingsResponse

    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.

    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