@emailbob/twingate/twingateGroup.d.ts

A Pulumi package for creating and managing Twingate cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Groups are how users are authorized to access Resources. For more information, see Twingate's [documentation](https://docs.twingate.com/docs/groups).
 *
 * ## Example Usage
 *
 * <!--Start PulumiCodeChooser -->
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as twingate from "@emailbob/twingate";
 *
 * const aws = new twingate.TwingateGroup("aws", {});
 * ```
 * <!--End PulumiCodeChooser -->
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import twingate:index/twingateGroup:TwingateGroup aws R3JvdXA6MzQ4OTE=
 * ```
 */
export declare class TwingateGroup extends pulumi.CustomResource {
    /**
     * Get an existing TwingateGroup 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?: TwingateGroupState, opts?: pulumi.CustomResourceOptions): TwingateGroup;
    /**
     * Returns true if the given object is an instance of TwingateGroup.  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 TwingateGroup;
    /**
     * Determines whether User assignments to this Group will override any existing assignments. Default is `true`. If set to
     * `false`, assignments made outside of Terraform will be ignored.
     */
    readonly isAuthoritative: pulumi.Output<boolean>;
    /**
     * The name of the group
     */
    readonly name: pulumi.Output<string>;
    /**
     * Defines which Security Policy applies to this Group. The Security Policy ID can be obtained from the `twingate.getTwingateSecurityPolicy` and `twingate.getTwingateSecurityPolicies` data sources.
     */
    readonly securityPolicyId: pulumi.Output<string>;
    /**
     * List of User IDs that have permission to access the Group.
     */
    readonly userIds: pulumi.Output<string[] | undefined>;
    /**
     * Create a TwingateGroup 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?: TwingateGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering TwingateGroup resources.
 */
export interface TwingateGroupState {
    /**
     * Determines whether User assignments to this Group will override any existing assignments. Default is `true`. If set to
     * `false`, assignments made outside of Terraform will be ignored.
     */
    isAuthoritative?: pulumi.Input<boolean>;
    /**
     * The name of the group
     */
    name?: pulumi.Input<string>;
    /**
     * Defines which Security Policy applies to this Group. The Security Policy ID can be obtained from the `twingate.getTwingateSecurityPolicy` and `twingate.getTwingateSecurityPolicies` data sources.
     */
    securityPolicyId?: pulumi.Input<string>;
    /**
     * List of User IDs that have permission to access the Group.
     */
    userIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a TwingateGroup resource.
 */
export interface TwingateGroupArgs {
    /**
     * Determines whether User assignments to this Group will override any existing assignments. Default is `true`. If set to
     * `false`, assignments made outside of Terraform will be ignored.
     */
    isAuthoritative?: pulumi.Input<boolean>;
    /**
     * The name of the group
     */
    name?: pulumi.Input<string>;
    /**
     * Defines which Security Policy applies to this Group. The Security Policy ID can be obtained from the `twingate.getTwingateSecurityPolicy` and `twingate.getTwingateSecurityPolicies` data sources.
     */
    securityPolicyId?: pulumi.Input<string>;
    /**
     * List of User IDs that have permission to access the Group.
     */
    userIds?: pulumi.Input<pulumi.Input<string>[]>;
}