1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateDNSFilteringProfile
Twingate v3.0.17 published on Wednesday, Apr 9, 2025 by Twingate

twingate.getTwingateDNSFilteringProfile

Explore with Pulumi AI

DNS filtering gives you the ability to control what websites your users can access. DNS filtering is only available on certain plans. For more information, see Twingate’s documentation. DNS filtering must be enabled for this data source to work. If DNS filtering isn’t enabled, the provider will throw an error.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as twingate from "@pulumi/twingate";

const example = twingate.getTwingateDNSFilteringProfile({
    id: "<your dns profile's id>",
});
Copy
import pulumi
import pulumi_twingate as twingate

example = twingate.get_twingate_dns_filtering_profile(id="<your dns profile's id>")
Copy
package main

import (
	"github.com/Twingate/pulumi-twingate/sdk/v3/go/twingate"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := twingate.LookupTwingateDNSFilteringProfile(ctx, &twingate.LookupTwingateDNSFilteringProfileArgs{
			Id: "<your dns profile's id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Twingate = Pulumi.Twingate;

return await Deployment.RunAsync(() => 
{
    var example = Twingate.GetTwingateDNSFilteringProfile.Invoke(new()
    {
        Id = "<your dns profile's id>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.twingate.TwingateFunctions;
import com.pulumi.twingate.inputs.GetTwingateDNSFilteringProfileArgs;
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) {
        final var example = TwingateFunctions.getTwingateDNSFilteringProfile(GetTwingateDNSFilteringProfileArgs.builder()
            .id("<your dns profile's id>")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: twingate:getTwingateDNSFilteringProfile
      arguments:
        id: <your dns profile's id>
Copy

Using getTwingateDNSFilteringProfile

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 getTwingateDNSFilteringProfile(args: GetTwingateDNSFilteringProfileArgs, opts?: InvokeOptions): Promise<GetTwingateDNSFilteringProfileResult>
function getTwingateDNSFilteringProfileOutput(args: GetTwingateDNSFilteringProfileOutputArgs, opts?: InvokeOptions): Output<GetTwingateDNSFilteringProfileResult>
Copy
def get_twingate_dns_filtering_profile(allowed_domains: Optional[GetTwingateDNSFilteringProfileAllowedDomains] = None,
                                       content_categories: Optional[GetTwingateDNSFilteringProfileContentCategories] = None,
                                       denied_domains: Optional[GetTwingateDNSFilteringProfileDeniedDomains] = None,
                                       id: Optional[str] = None,
                                       privacy_categories: Optional[GetTwingateDNSFilteringProfilePrivacyCategories] = None,
                                       security_categories: Optional[GetTwingateDNSFilteringProfileSecurityCategories] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetTwingateDNSFilteringProfileResult
def get_twingate_dns_filtering_profile_output(allowed_domains: Optional[pulumi.Input[GetTwingateDNSFilteringProfileAllowedDomainsArgs]] = None,
                                       content_categories: Optional[pulumi.Input[GetTwingateDNSFilteringProfileContentCategoriesArgs]] = None,
                                       denied_domains: Optional[pulumi.Input[GetTwingateDNSFilteringProfileDeniedDomainsArgs]] = None,
                                       id: Optional[pulumi.Input[str]] = None,
                                       privacy_categories: Optional[pulumi.Input[GetTwingateDNSFilteringProfilePrivacyCategoriesArgs]] = None,
                                       security_categories: Optional[pulumi.Input[GetTwingateDNSFilteringProfileSecurityCategoriesArgs]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetTwingateDNSFilteringProfileResult]
Copy
func LookupTwingateDNSFilteringProfile(ctx *Context, args *LookupTwingateDNSFilteringProfileArgs, opts ...InvokeOption) (*LookupTwingateDNSFilteringProfileResult, error)
func LookupTwingateDNSFilteringProfileOutput(ctx *Context, args *LookupTwingateDNSFilteringProfileOutputArgs, opts ...InvokeOption) LookupTwingateDNSFilteringProfileResultOutput
Copy

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

public static class GetTwingateDNSFilteringProfile 
{
    public static Task<GetTwingateDNSFilteringProfileResult> InvokeAsync(GetTwingateDNSFilteringProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateDNSFilteringProfileResult> Invoke(GetTwingateDNSFilteringProfileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTwingateDNSFilteringProfileResult> getTwingateDNSFilteringProfile(GetTwingateDNSFilteringProfileArgs args, InvokeOptions options)
public static Output<GetTwingateDNSFilteringProfileResult> getTwingateDNSFilteringProfile(GetTwingateDNSFilteringProfileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: twingate:index/getTwingateDNSFilteringProfile:getTwingateDNSFilteringProfile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The DNS filtering profile's ID.
AllowedDomains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
ContentCategories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
DeniedDomains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
PrivacyCategories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
SecurityCategories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
id This property is required. String
The DNS filtering profile's ID.
allowedDomains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
contentCategories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
deniedDomains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
privacyCategories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
securityCategories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
id This property is required. string
The DNS filtering profile's ID.
allowedDomains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
contentCategories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
deniedDomains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
privacyCategories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
securityCategories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
id This property is required. str
The DNS filtering profile's ID.
allowed_domains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
content_categories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
denied_domains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
privacy_categories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
security_categories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
id This property is required. String
The DNS filtering profile's ID.
allowedDomains Property Map
A block with the following attributes.
contentCategories Property Map
A block with the following attributes.
deniedDomains Property Map
A block with the following attributes.
privacyCategories Property Map
A block with the following attributes.
securityCategories Property Map
A block with the following attributes.

getTwingateDNSFilteringProfile Result

The following output properties are available:

FallbackMethod string
The DNS filtering profile's fallback method. One of AUTOMATIC or STRICT.
Groups List<string>
A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
Id string
The DNS filtering profile's ID.
Name string
The DNS filtering profile's name.
Priority double
A floating point number representing the profile's priority.
AllowedDomains Twingate.Twingate.Outputs.GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
ContentCategories Twingate.Twingate.Outputs.GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
DeniedDomains Twingate.Twingate.Outputs.GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
PrivacyCategories Twingate.Twingate.Outputs.GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
SecurityCategories Twingate.Twingate.Outputs.GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
FallbackMethod string
The DNS filtering profile's fallback method. One of AUTOMATIC or STRICT.
Groups []string
A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
Id string
The DNS filtering profile's ID.
Name string
The DNS filtering profile's name.
Priority float64
A floating point number representing the profile's priority.
AllowedDomains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
ContentCategories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
DeniedDomains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
PrivacyCategories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
SecurityCategories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
fallbackMethod String
The DNS filtering profile's fallback method. One of AUTOMATIC or STRICT.
groups List<String>
A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
id String
The DNS filtering profile's ID.
name String
The DNS filtering profile's name.
priority Double
A floating point number representing the profile's priority.
allowedDomains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
contentCategories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
deniedDomains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
privacyCategories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
securityCategories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
fallbackMethod string
The DNS filtering profile's fallback method. One of AUTOMATIC or STRICT.
groups string[]
A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
id string
The DNS filtering profile's ID.
name string
The DNS filtering profile's name.
priority number
A floating point number representing the profile's priority.
allowedDomains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
contentCategories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
deniedDomains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
privacyCategories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
securityCategories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
fallback_method str
The DNS filtering profile's fallback method. One of AUTOMATIC or STRICT.
groups Sequence[str]
A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
id str
The DNS filtering profile's ID.
name str
The DNS filtering profile's name.
priority float
A floating point number representing the profile's priority.
allowed_domains GetTwingateDNSFilteringProfileAllowedDomains
A block with the following attributes.
content_categories GetTwingateDNSFilteringProfileContentCategories
A block with the following attributes.
denied_domains GetTwingateDNSFilteringProfileDeniedDomains
A block with the following attributes.
privacy_categories GetTwingateDNSFilteringProfilePrivacyCategories
A block with the following attributes.
security_categories GetTwingateDNSFilteringProfileSecurityCategories
A block with the following attributes.
fallbackMethod String
The DNS filtering profile's fallback method. One of AUTOMATIC or STRICT.
groups List<String>
A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
id String
The DNS filtering profile's ID.
name String
The DNS filtering profile's name.
priority Number
A floating point number representing the profile's priority.
allowedDomains Property Map
A block with the following attributes.
contentCategories Property Map
A block with the following attributes.
deniedDomains Property Map
A block with the following attributes.
privacyCategories Property Map
A block with the following attributes.
securityCategories Property Map
A block with the following attributes.

Supporting Types

GetTwingateDNSFilteringProfileAllowedDomains

Domains This property is required. List<string>
A set of allowed domains.
Domains This property is required. []string
A set of allowed domains.
domains This property is required. List<String>
A set of allowed domains.
domains This property is required. string[]
A set of allowed domains.
domains This property is required. Sequence[str]
A set of allowed domains.
domains This property is required. List<String>
A set of allowed domains.

GetTwingateDNSFilteringProfileContentCategories

BlockAdultContent This property is required. bool
Whether to block adult content.
BlockDating This property is required. bool
Whether to block dating content.
BlockGambling This property is required. bool
Whether to block gambling content.
BlockGames This property is required. bool
Whether to block games.
BlockPiracy This property is required. bool
Whether to block piracy sites.
BlockSocialMedia This property is required. bool
Whether to block social media.
BlockStreaming This property is required. bool
Whether to block streaming content.
EnableSafesearch This property is required. bool
Whether to force safe search.
EnableYoutubeRestrictedMode This property is required. bool
Whether to force YouTube to use restricted mode.
BlockAdultContent This property is required. bool
Whether to block adult content.
BlockDating This property is required. bool
Whether to block dating content.
BlockGambling This property is required. bool
Whether to block gambling content.
BlockGames This property is required. bool
Whether to block games.
BlockPiracy This property is required. bool
Whether to block piracy sites.
BlockSocialMedia This property is required. bool
Whether to block social media.
BlockStreaming This property is required. bool
Whether to block streaming content.
EnableSafesearch This property is required. bool
Whether to force safe search.
EnableYoutubeRestrictedMode This property is required. bool
Whether to force YouTube to use restricted mode.
blockAdultContent This property is required. Boolean
Whether to block adult content.
blockDating This property is required. Boolean
Whether to block dating content.
blockGambling This property is required. Boolean
Whether to block gambling content.
blockGames This property is required. Boolean
Whether to block games.
blockPiracy This property is required. Boolean
Whether to block piracy sites.
blockSocialMedia This property is required. Boolean
Whether to block social media.
blockStreaming This property is required. Boolean
Whether to block streaming content.
enableSafesearch This property is required. Boolean
Whether to force safe search.
enableYoutubeRestrictedMode This property is required. Boolean
Whether to force YouTube to use restricted mode.
blockAdultContent This property is required. boolean
Whether to block adult content.
blockDating This property is required. boolean
Whether to block dating content.
blockGambling This property is required. boolean
Whether to block gambling content.
blockGames This property is required. boolean
Whether to block games.
blockPiracy This property is required. boolean
Whether to block piracy sites.
blockSocialMedia This property is required. boolean
Whether to block social media.
blockStreaming This property is required. boolean
Whether to block streaming content.
enableSafesearch This property is required. boolean
Whether to force safe search.
enableYoutubeRestrictedMode This property is required. boolean
Whether to force YouTube to use restricted mode.
block_adult_content This property is required. bool
Whether to block adult content.
block_dating This property is required. bool
Whether to block dating content.
block_gambling This property is required. bool
Whether to block gambling content.
block_games This property is required. bool
Whether to block games.
block_piracy This property is required. bool
Whether to block piracy sites.
block_social_media This property is required. bool
Whether to block social media.
block_streaming This property is required. bool
Whether to block streaming content.
enable_safesearch This property is required. bool
Whether to force safe search.
enable_youtube_restricted_mode This property is required. bool
Whether to force YouTube to use restricted mode.
blockAdultContent This property is required. Boolean
Whether to block adult content.
blockDating This property is required. Boolean
Whether to block dating content.
blockGambling This property is required. Boolean
Whether to block gambling content.
blockGames This property is required. Boolean
Whether to block games.
blockPiracy This property is required. Boolean
Whether to block piracy sites.
blockSocialMedia This property is required. Boolean
Whether to block social media.
blockStreaming This property is required. Boolean
Whether to block streaming content.
enableSafesearch This property is required. Boolean
Whether to force safe search.
enableYoutubeRestrictedMode This property is required. Boolean
Whether to force YouTube to use restricted mode.

GetTwingateDNSFilteringProfileDeniedDomains

Domains This property is required. List<string>
A set of denied domains.
Domains This property is required. []string
A set of denied domains.
domains This property is required. List<String>
A set of denied domains.
domains This property is required. string[]
A set of denied domains.
domains This property is required. Sequence[str]
A set of denied domains.
domains This property is required. List<String>
A set of denied domains.

GetTwingateDNSFilteringProfilePrivacyCategories

BlockAdsAndTrackers This property is required. bool
Whether to block ads and trackers.
BlockAffiliateLinks This property is required. bool
Whether to block affiliate links.
BlockDisguisedTrackers This property is required. bool
Whether to block disguised third party trackers.
BlockAdsAndTrackers This property is required. bool
Whether to block ads and trackers.
BlockAffiliateLinks This property is required. bool
Whether to block affiliate links.
BlockDisguisedTrackers This property is required. bool
Whether to block disguised third party trackers.
blockAdsAndTrackers This property is required. Boolean
Whether to block ads and trackers.
blockAffiliateLinks This property is required. Boolean
Whether to block affiliate links.
blockDisguisedTrackers This property is required. Boolean
Whether to block disguised third party trackers.
blockAdsAndTrackers This property is required. boolean
Whether to block ads and trackers.
blockAffiliateLinks This property is required. boolean
Whether to block affiliate links.
blockDisguisedTrackers This property is required. boolean
Whether to block disguised third party trackers.
block_ads_and_trackers This property is required. bool
Whether to block ads and trackers.
block_affiliate_links This property is required. bool
Whether to block affiliate links.
block_disguised_trackers This property is required. bool
Whether to block disguised third party trackers.
blockAdsAndTrackers This property is required. Boolean
Whether to block ads and trackers.
blockAffiliateLinks This property is required. Boolean
Whether to block affiliate links.
blockDisguisedTrackers This property is required. Boolean
Whether to block disguised third party trackers.

GetTwingateDNSFilteringProfileSecurityCategories

BlockCryptojacking This property is required. bool
Whether to block cryptojacking sites.
BlockDnsRebinding This property is required. bool
Blocks public DNS entries from returning private IP addresses.
BlockDomainGenerationAlgorithms This property is required. bool
Blocks DGA domains.
BlockIdnHomoglyph This property is required. bool
Whether to block homoglyph attacks.
BlockNewlyRegisteredDomains This property is required. bool
Blocks newly registered domains.
BlockParkedDomains This property is required. bool
Block parked domains.
BlockTyposquatting This property is required. bool
Blocks typosquatted domains.
EnableGoogleSafeBrowsing This property is required. bool
Whether to use Google Safe browsing lists to block content.
EnableThreatIntelligenceFeeds This property is required. bool
Whether to filter content using threat intelligence feeds.
BlockCryptojacking This property is required. bool
Whether to block cryptojacking sites.
BlockDnsRebinding This property is required. bool
Blocks public DNS entries from returning private IP addresses.
BlockDomainGenerationAlgorithms This property is required. bool
Blocks DGA domains.
BlockIdnHomoglyph This property is required. bool
Whether to block homoglyph attacks.
BlockNewlyRegisteredDomains This property is required. bool
Blocks newly registered domains.
BlockParkedDomains This property is required. bool
Block parked domains.
BlockTyposquatting This property is required. bool
Blocks typosquatted domains.
EnableGoogleSafeBrowsing This property is required. bool
Whether to use Google Safe browsing lists to block content.
EnableThreatIntelligenceFeeds This property is required. bool
Whether to filter content using threat intelligence feeds.
blockCryptojacking This property is required. Boolean
Whether to block cryptojacking sites.
blockDnsRebinding This property is required. Boolean
Blocks public DNS entries from returning private IP addresses.
blockDomainGenerationAlgorithms This property is required. Boolean
Blocks DGA domains.
blockIdnHomoglyph This property is required. Boolean
Whether to block homoglyph attacks.
blockNewlyRegisteredDomains This property is required. Boolean
Blocks newly registered domains.
blockParkedDomains This property is required. Boolean
Block parked domains.
blockTyposquatting This property is required. Boolean
Blocks typosquatted domains.
enableGoogleSafeBrowsing This property is required. Boolean
Whether to use Google Safe browsing lists to block content.
enableThreatIntelligenceFeeds This property is required. Boolean
Whether to filter content using threat intelligence feeds.
blockCryptojacking This property is required. boolean
Whether to block cryptojacking sites.
blockDnsRebinding This property is required. boolean
Blocks public DNS entries from returning private IP addresses.
blockDomainGenerationAlgorithms This property is required. boolean
Blocks DGA domains.
blockIdnHomoglyph This property is required. boolean
Whether to block homoglyph attacks.
blockNewlyRegisteredDomains This property is required. boolean
Blocks newly registered domains.
blockParkedDomains This property is required. boolean
Block parked domains.
blockTyposquatting This property is required. boolean
Blocks typosquatted domains.
enableGoogleSafeBrowsing This property is required. boolean
Whether to use Google Safe browsing lists to block content.
enableThreatIntelligenceFeeds This property is required. boolean
Whether to filter content using threat intelligence feeds.
block_cryptojacking This property is required. bool
Whether to block cryptojacking sites.
block_dns_rebinding This property is required. bool
Blocks public DNS entries from returning private IP addresses.
block_domain_generation_algorithms This property is required. bool
Blocks DGA domains.
block_idn_homoglyph This property is required. bool
Whether to block homoglyph attacks.
block_newly_registered_domains This property is required. bool
Blocks newly registered domains.
block_parked_domains This property is required. bool
Block parked domains.
block_typosquatting This property is required. bool
Blocks typosquatted domains.
enable_google_safe_browsing This property is required. bool
Whether to use Google Safe browsing lists to block content.
enable_threat_intelligence_feeds This property is required. bool
Whether to filter content using threat intelligence feeds.
blockCryptojacking This property is required. Boolean
Whether to block cryptojacking sites.
blockDnsRebinding This property is required. Boolean
Blocks public DNS entries from returning private IP addresses.
blockDomainGenerationAlgorithms This property is required. Boolean
Blocks DGA domains.
blockIdnHomoglyph This property is required. Boolean
Whether to block homoglyph attacks.
blockNewlyRegisteredDomains This property is required. Boolean
Blocks newly registered domains.
blockParkedDomains This property is required. Boolean
Block parked domains.
blockTyposquatting This property is required. Boolean
Blocks typosquatted domains.
enableGoogleSafeBrowsing This property is required. Boolean
Whether to use Google Safe browsing lists to block content.
enableThreatIntelligenceFeeds This property is required. Boolean
Whether to filter content using threat intelligence feeds.

Package Details

Repository
twingate Twingate/pulumi-twingate
License
Apache-2.0
Notes
This Pulumi package is based on the twingate Terraform Provider.