@twingate/pulumi-twingate/twingateDNSFilteringProfile.d.ts

A Pulumi package for creating and managing Twingate cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * 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](https://www.twingate.com/docs/dns-filtering). DNS filtering must be enabled for this resources to work. If DNS filtering isn't enabled, the provider will throw an error.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as std from "@pulumi/std";
 * import * as twingate from "@twingate/pulumi-twingate";
 *
 * const example1 = new twingate.TwingateGroup("example1", {name: "example_1"});
 * const example2 = new twingate.TwingateGroup("example2", {name: "example_2"});
 * const example = twingate.getTwingateGroups({
 *     namePrefix: "example",
 * });
 * const exampleTwingateDNSFilteringProfile = new twingate.TwingateDNSFilteringProfile("example", {
 *     name: "Example DNS Filtering Profile",
 *     priority: 2,
 *     fallbackMethod: "AUTO",
 *     groups: example.then(example => std.toset({
 *         input: example.groups.map(__item => __item.id),
 *     })).then(invoke => invoke.result),
 *     allowedDomains: {
 *         isAuthoritative: false,
 *         domains: [
 *             "twingate.com",
 *             "zoom.us",
 *         ],
 *     },
 *     deniedDomains: {
 *         isAuthoritative: true,
 *         domains: ["evil.example"],
 *     },
 *     contentCategories: {
 *         blockAdultContent: true,
 *     },
 *     securityCategories: {
 *         blockDnsRebinding: false,
 *         blockNewlyRegisteredDomains: false,
 *     },
 *     privacyCategories: {
 *         blockDisguisedTrackers: true,
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import twingate:index/twingateDNSFilteringProfile:TwingateDNSFilteringProfile example RG5zRmlsdGVyaW5nUHJvZmlsZToxY2I4YzM0YTc0
 * ```
 */
export declare class TwingateDNSFilteringProfile extends pulumi.CustomResource {
    /**
     * Get an existing TwingateDNSFilteringProfile resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TwingateDNSFilteringProfileState, opts?: pulumi.CustomResourceOptions): TwingateDNSFilteringProfile;
    /**
     * Returns true if the given object is an instance of TwingateDNSFilteringProfile.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is TwingateDNSFilteringProfile;
    /**
     * A block with the following attributes.
     */
    readonly allowedDomains: pulumi.Output<outputs.TwingateDNSFilteringProfileAllowedDomains | undefined>;
    /**
     * A block with the following attributes.
     */
    readonly contentCategories: pulumi.Output<outputs.TwingateDNSFilteringProfileContentCategories | undefined>;
    /**
     * A block with the following attributes.
     */
    readonly deniedDomains: pulumi.Output<outputs.TwingateDNSFilteringProfileDeniedDomains | undefined>;
    /**
     * The DNS filtering profile's fallback method. One of "AUTO" or "STRICT". Defaults to "STRICT".
     */
    readonly fallbackMethod: pulumi.Output<string>;
    /**
     * A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
     */
    readonly groups: pulumi.Output<string[]>;
    /**
     * The DNS filtering profile's name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * A floating point number representing the profile's priority.
     */
    readonly priority: pulumi.Output<number>;
    /**
     * A block with the following attributes.
     */
    readonly privacyCategories: pulumi.Output<outputs.TwingateDNSFilteringProfilePrivacyCategories | undefined>;
    /**
     * A block with the following attributes.
     */
    readonly securityCategories: pulumi.Output<outputs.TwingateDNSFilteringProfileSecurityCategories | undefined>;
    /**
     * Create a TwingateDNSFilteringProfile resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: TwingateDNSFilteringProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering TwingateDNSFilteringProfile resources.
 */
export interface TwingateDNSFilteringProfileState {
    /**
     * A block with the following attributes.
     */
    allowedDomains?: pulumi.Input<inputs.TwingateDNSFilteringProfileAllowedDomains>;
    /**
     * A block with the following attributes.
     */
    contentCategories?: pulumi.Input<inputs.TwingateDNSFilteringProfileContentCategories>;
    /**
     * A block with the following attributes.
     */
    deniedDomains?: pulumi.Input<inputs.TwingateDNSFilteringProfileDeniedDomains>;
    /**
     * The DNS filtering profile's fallback method. One of "AUTO" or "STRICT". Defaults to "STRICT".
     */
    fallbackMethod?: pulumi.Input<string>;
    /**
     * A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
     */
    groups?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The DNS filtering profile's name.
     */
    name?: pulumi.Input<string>;
    /**
     * A floating point number representing the profile's priority.
     */
    priority?: pulumi.Input<number>;
    /**
     * A block with the following attributes.
     */
    privacyCategories?: pulumi.Input<inputs.TwingateDNSFilteringProfilePrivacyCategories>;
    /**
     * A block with the following attributes.
     */
    securityCategories?: pulumi.Input<inputs.TwingateDNSFilteringProfileSecurityCategories>;
}
/**
 * The set of arguments for constructing a TwingateDNSFilteringProfile resource.
 */
export interface TwingateDNSFilteringProfileArgs {
    /**
     * A block with the following attributes.
     */
    allowedDomains?: pulumi.Input<inputs.TwingateDNSFilteringProfileAllowedDomains>;
    /**
     * A block with the following attributes.
     */
    contentCategories?: pulumi.Input<inputs.TwingateDNSFilteringProfileContentCategories>;
    /**
     * A block with the following attributes.
     */
    deniedDomains?: pulumi.Input<inputs.TwingateDNSFilteringProfileDeniedDomains>;
    /**
     * The DNS filtering profile's fallback method. One of "AUTO" or "STRICT". Defaults to "STRICT".
     */
    fallbackMethod?: pulumi.Input<string>;
    /**
     * A set of group IDs that have this as their DNS filtering profile. Defaults to an empty set.
     */
    groups?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The DNS filtering profile's name.
     */
    name?: pulumi.Input<string>;
    /**
     * A floating point number representing the profile's priority.
     */
    priority: pulumi.Input<number>;
    /**
     * A block with the following attributes.
     */
    privacyCategories?: pulumi.Input<inputs.TwingateDNSFilteringProfilePrivacyCategories>;
    /**
     * A block with the following attributes.
     */
    securityCategories?: pulumi.Input<inputs.TwingateDNSFilteringProfileSecurityCategories>;
}