Docs Packages
  1. Packages
  2. Twingate
  3. API Docs
  4. TwingateGroup
Twingate v3.0.6 published on Thursday, Jun 27, 2024 by Twingate
Twingate/pulumi-twingate

twingate.TwingateGroup

Explore with Pulumi AI

twingate logo
Twingate v3.0.6 published on Thursday, Jun 27, 2024 by Twingate
Twingate/pulumi-twingate

    Groups are how users are authorized to access Resources. For more information, see Twingate’s documentation.

    Example Usage

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

const aws = new twingate.TwingateGroup("aws", {});

    import pulumi
import pulumi_twingate as twingate

aws = twingate.TwingateGroup("aws")

    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.NewTwingateGroup(ctx, "aws", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Twingate = Twingate.Twingate;

return await Deployment.RunAsync(() => 
{
    var aws = new Twingate.TwingateGroup("aws");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.twingate.TwingateGroup;
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) {
        var aws = new TwingateGroup("aws");

    }
}

    resources:
  aws:
    type: twingate:TwingateGroup

    Create TwingateGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TwingateGroup(name: string, args?: TwingateGroupArgs, opts?: CustomResourceOptions);
    @overload
def TwingateGroup(resource_name: str,
                  args: Optional[TwingateGroupArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def TwingateGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  is_authoritative: Optional[bool] = None,
                  name: Optional[str] = None,
                  security_policy_id: Optional[str] = None,
                  user_ids: Optional[Sequence[str]] = None)
    func NewTwingateGroup(ctx *Context, name string, args *TwingateGroupArgs, opts ...ResourceOption) (*TwingateGroup, error)
    public TwingateGroup(string name, TwingateGroupArgs? args = null, CustomResourceOptions? opts = null)
    public TwingateGroup(String name, TwingateGroupArgs args)
public TwingateGroup(String name, TwingateGroupArgs args, CustomResourceOptions options)

    type: twingate:TwingateGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TwingateGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TwingateGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TwingateGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TwingateGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TwingateGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var twingateGroupResource = new Twingate.TwingateGroup("twingateGroupResource", new()
{
    IsAuthoritative = false,
    Name = "string",
    SecurityPolicyId = "string",
    UserIds = new[]
    {
        "string",
    },
});

    example, err := twingate.NewTwingateGroup(ctx, "twingateGroupResource", &twingate.TwingateGroupArgs{
	IsAuthoritative:  pulumi.Bool(false),
	Name:             pulumi.String("string"),
	SecurityPolicyId: pulumi.String("string"),
	UserIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var twingateGroupResource = new TwingateGroup("twingateGroupResource", TwingateGroupArgs.builder()
    .isAuthoritative(false)
    .name("string")
    .securityPolicyId("string")
    .userIds("string")
    .build());

    twingate_group_resource = twingate.TwingateGroup("twingateGroupResource",
    is_authoritative=False,
    name="string",
    security_policy_id="string",
    user_ids=["string"])

    const twingateGroupResource = new twingate.TwingateGroup("twingateGroupResource", {
    isAuthoritative: false,
    name: "string",
    securityPolicyId: "string",
    userIds: ["string"],
});

    type: twingate:TwingateGroup
properties:
    isAuthoritative: false
    name: string
    securityPolicyId: string
    userIds:
        - string

    TwingateGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TwingateGroup resource accepts the following input properties:

    IsAuthoritative bool
    Name string
    The name of the group
    SecurityPolicyId 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.
    UserIds List<string>
    List of User IDs that have permission to access the Group.
    IsAuthoritative bool
    Name string
    The name of the group
    SecurityPolicyId 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.
    UserIds []string
    List of User IDs that have permission to access the Group.
    isAuthoritative Boolean
    name String
    The name of the group
    securityPolicyId 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.
    userIds List<String>
    List of User IDs that have permission to access the Group.
    isAuthoritative boolean
    name string
    The name of the group
    securityPolicyId 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.
    userIds string[]
    List of User IDs that have permission to access the Group.
    is_authoritative bool
    name str
    The name of the group
    security_policy_id str
    Defines which Security Policy applies to this Group. The Security Policy ID can be obtained from the twingate.getTwingateSecurityPolicy and twingate.getTwingateSecurityPolicies data sources.
    user_ids Sequence[str]
    List of User IDs that have permission to access the Group.
    isAuthoritative Boolean
    name String
    The name of the group
    securityPolicyId 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.
    userIds List<String>
    List of User IDs that have permission to access the Group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TwingateGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TwingateGroup Resource

    Get an existing TwingateGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TwingateGroupState, opts?: CustomResourceOptions): TwingateGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        is_authoritative: Optional[bool] = None,
        name: Optional[str] = None,
        security_policy_id: Optional[str] = None,
        user_ids: Optional[Sequence[str]] = None) -> TwingateGroup
    func GetTwingateGroup(ctx *Context, name string, id IDInput, state *TwingateGroupState, opts ...ResourceOption) (*TwingateGroup, error)
    public static TwingateGroup Get(string name, Input<string> id, TwingateGroupState? state, CustomResourceOptions? opts = null)
    public static TwingateGroup get(String name, Output<String> id, TwingateGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    IsAuthoritative bool
    Name string
    The name of the group
    SecurityPolicyId 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.
    UserIds List<string>
    List of User IDs that have permission to access the Group.
    IsAuthoritative bool
    Name string
    The name of the group
    SecurityPolicyId 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.
    UserIds []string
    List of User IDs that have permission to access the Group.
    isAuthoritative Boolean
    name String
    The name of the group
    securityPolicyId 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.
    userIds List<String>
    List of User IDs that have permission to access the Group.
    isAuthoritative boolean
    name string
    The name of the group
    securityPolicyId 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.
    userIds string[]
    List of User IDs that have permission to access the Group.
    is_authoritative bool
    name str
    The name of the group
    security_policy_id str
    Defines which Security Policy applies to this Group. The Security Policy ID can be obtained from the twingate.getTwingateSecurityPolicy and twingate.getTwingateSecurityPolicies data sources.
    user_ids Sequence[str]
    List of User IDs that have permission to access the Group.
    isAuthoritative Boolean
    name String
    The name of the group
    securityPolicyId 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.
    userIds List<String>
    List of User IDs that have permission to access the Group.

    Import

    $ pulumi import twingate:index/twingateGroup:TwingateGroup aws R3JvdXA6MzQ4OTE=

    To learn more about importing existing cloud resources, see Importing resources.

    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.6 published on Thursday, Jun 27, 2024 by Twingate
    Twingate/pulumi-twingate