Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateDNSFilteringProfile
Twingate v3.0.11 published on Wednesday, Aug 28, 2024 by Twingate
Twingate/pulumi-twingate

twingate.getTwingateDNSFilteringProfile

Explore with Pulumi AI

twingate logo
Twingate v3.0.11 published on Wednesday, Aug 28, 2024 by Twingate
Twingate/pulumi-twingate

    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>",
});

    import pulumi
import pulumi_twingate as twingate

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

    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
	})
}

    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>",
    });

});

    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());

    }
}

    variables:
  example:
    fn::invoke:
      Function: twingate:getTwingateDNSFilteringProfile
      Arguments:
        id: <your dns profile's id>

    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>
    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]
    func LookupTwingateDNSFilteringProfile(ctx *Context, args *LookupTwingateDNSFilteringProfileArgs, opts ...InvokeOption) (*LookupTwingateDNSFilteringProfileResult, error)
func LookupTwingateDNSFilteringProfileOutput(ctx *Context, args *LookupTwingateDNSFilteringProfileOutputArgs, opts ...InvokeOption) LookupTwingateDNSFilteringProfileResultOutput

    > 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)
}
    public static CompletableFuture<GetTwingateDNSFilteringProfileResult> getTwingateDNSFilteringProfile(GetTwingateDNSFilteringProfileArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: twingate:index/getTwingateDNSFilteringProfile:getTwingateDNSFilteringProfile
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id 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 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 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 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 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 List<string>
    A set of allowed domains.
    Domains []string
    A set of allowed domains.
    domains List<String>
    A set of allowed domains.
    domains string[]
    A set of allowed domains.
    domains Sequence[str]
    A set of allowed domains.
    domains List<String>
    A set of allowed domains.

    GetTwingateDNSFilteringProfileContentCategories

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

    GetTwingateDNSFilteringProfileDeniedDomains

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

    GetTwingateDNSFilteringProfilePrivacyCategories

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

    GetTwingateDNSFilteringProfileSecurityCategories

    BlockCryptojacking bool
    Whether to block cryptojacking sites.
    BlockDnsRebinding bool
    Blocks public DNS entries from returning private IP addresses.
    BlockDomainGenerationAlgorithms bool
    Blocks DGA domains.
    BlockIdnHomoglyph bool
    Whether to block homoglyph attacks.
    BlockNewlyRegisteredDomains bool
    Blocks newly registered domains.
    BlockParkedDomains bool
    Block parked domains.
    BlockTyposquatting bool
    Blocks typosquatted domains.
    EnableGoogleSafeBrowsing bool
    Whether to use Google Safe browsing lists to block content.
    EnableThreatIntelligenceFeeds bool
    Whether to filter content using threat intelligence feeds.
    BlockCryptojacking bool
    Whether to block cryptojacking sites.
    BlockDnsRebinding bool
    Blocks public DNS entries from returning private IP addresses.
    BlockDomainGenerationAlgorithms bool
    Blocks DGA domains.
    BlockIdnHomoglyph bool
    Whether to block homoglyph attacks.
    BlockNewlyRegisteredDomains bool
    Blocks newly registered domains.
    BlockParkedDomains bool
    Block parked domains.
    BlockTyposquatting bool
    Blocks typosquatted domains.
    EnableGoogleSafeBrowsing bool
    Whether to use Google Safe browsing lists to block content.
    EnableThreatIntelligenceFeeds bool
    Whether to filter content using threat intelligence feeds.
    blockCryptojacking Boolean
    Whether to block cryptojacking sites.
    blockDnsRebinding Boolean
    Blocks public DNS entries from returning private IP addresses.
    blockDomainGenerationAlgorithms Boolean
    Blocks DGA domains.
    blockIdnHomoglyph Boolean
    Whether to block homoglyph attacks.
    blockNewlyRegisteredDomains Boolean
    Blocks newly registered domains.
    blockParkedDomains Boolean
    Block parked domains.
    blockTyposquatting Boolean
    Blocks typosquatted domains.
    enableGoogleSafeBrowsing Boolean
    Whether to use Google Safe browsing lists to block content.
    enableThreatIntelligenceFeeds Boolean
    Whether to filter content using threat intelligence feeds.
    blockCryptojacking boolean
    Whether to block cryptojacking sites.
    blockDnsRebinding boolean
    Blocks public DNS entries from returning private IP addresses.
    blockDomainGenerationAlgorithms boolean
    Blocks DGA domains.
    blockIdnHomoglyph boolean
    Whether to block homoglyph attacks.
    blockNewlyRegisteredDomains boolean
    Blocks newly registered domains.
    blockParkedDomains boolean
    Block parked domains.
    blockTyposquatting boolean
    Blocks typosquatted domains.
    enableGoogleSafeBrowsing boolean
    Whether to use Google Safe browsing lists to block content.
    enableThreatIntelligenceFeeds boolean
    Whether to filter content using threat intelligence feeds.
    block_cryptojacking bool
    Whether to block cryptojacking sites.
    block_dns_rebinding bool
    Blocks public DNS entries from returning private IP addresses.
    block_domain_generation_algorithms bool
    Blocks DGA domains.
    block_idn_homoglyph bool
    Whether to block homoglyph attacks.
    block_newly_registered_domains bool
    Blocks newly registered domains.
    block_parked_domains bool
    Block parked domains.
    block_typosquatting bool
    Blocks typosquatted domains.
    enable_google_safe_browsing bool
    Whether to use Google Safe browsing lists to block content.
    enable_threat_intelligence_feeds bool
    Whether to filter content using threat intelligence feeds.
    blockCryptojacking Boolean
    Whether to block cryptojacking sites.
    blockDnsRebinding Boolean
    Blocks public DNS entries from returning private IP addresses.
    blockDomainGenerationAlgorithms Boolean
    Blocks DGA domains.
    blockIdnHomoglyph Boolean
    Whether to block homoglyph attacks.
    blockNewlyRegisteredDomains Boolean
    Blocks newly registered domains.
    blockParkedDomains Boolean
    Block parked domains.
    blockTyposquatting Boolean
    Blocks typosquatted domains.
    enableGoogleSafeBrowsing Boolean
    Whether to use Google Safe browsing lists to block content.
    enableThreatIntelligenceFeeds 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.
    twingate logo
    Twingate v3.0.11 published on Wednesday, Aug 28, 2024 by Twingate
    Twingate/pulumi-twingate