1. Packages
  2. Zenduty Provider
  3. API Docs
  4. Invite
zenduty 1.0.4 published on Wednesday, Apr 2, 2025 by zenduty

zenduty.Invite

Explore with Pulumi AI

Create Invite Resource

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

Constructor syntax

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

@overload
def Invite(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           email_accounts: Optional[Sequence[InviteEmailAccountArgs]] = None,
           team: Optional[str] = None,
           invite_id: Optional[str] = None)
func NewInvite(ctx *Context, name string, args InviteArgs, opts ...ResourceOption) (*Invite, error)
public Invite(string name, InviteArgs args, CustomResourceOptions? opts = null)
public Invite(String name, InviteArgs args)
public Invite(String name, InviteArgs args, CustomResourceOptions options)
type: zenduty:Invite
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InviteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InviteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InviteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InviteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InviteArgs
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 inviteResource = new Zenduty.Invite("inviteResource", new()
{
    EmailAccounts = new[]
    {
        new Zenduty.Inputs.InviteEmailAccountArgs
        {
            Email = "string",
            FirstName = "string",
            LastName = "string",
            Role = 0,
        },
    },
    Team = "string",
    InviteId = "string",
});
Copy
example, err := zenduty.NewInvite(ctx, "inviteResource", &zenduty.InviteArgs{
EmailAccounts: .InviteEmailAccountArray{
&.InviteEmailAccountArgs{
Email: pulumi.String("string"),
FirstName: pulumi.String("string"),
LastName: pulumi.String("string"),
Role: pulumi.Float64(0),
},
},
Team: pulumi.String("string"),
InviteId: pulumi.String("string"),
})
Copy
var inviteResource = new Invite("inviteResource", InviteArgs.builder()
    .emailAccounts(InviteEmailAccountArgs.builder()
        .email("string")
        .firstName("string")
        .lastName("string")
        .role(0)
        .build())
    .team("string")
    .inviteId("string")
    .build());
Copy
invite_resource = zenduty.Invite("inviteResource",
    email_accounts=[{
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "role": 0,
    }],
    team="string",
    invite_id="string")
Copy
const inviteResource = new zenduty.Invite("inviteResource", {
    emailAccounts: [{
        email: "string",
        firstName: "string",
        lastName: "string",
        role: 0,
    }],
    team: "string",
    inviteId: "string",
});
Copy
type: zenduty:Invite
properties:
    emailAccounts:
        - email: string
          firstName: string
          lastName: string
          role: 0
    inviteId: string
    team: string
Copy

Invite Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Invite resource accepts the following input properties:

EmailAccounts This property is required. List<InviteEmailAccount>
Team This property is required. string
InviteId string
EmailAccounts This property is required. []InviteEmailAccountArgs
Team This property is required. string
InviteId string
emailAccounts This property is required. List<InviteEmailAccount>
team This property is required. String
inviteId String
emailAccounts This property is required. InviteEmailAccount[]
team This property is required. string
inviteId string
email_accounts This property is required. Sequence[InviteEmailAccountArgs]
team This property is required. str
invite_id str
emailAccounts This property is required. List<Property Map>
team This property is required. String
inviteId String

Outputs

All input properties are implicitly available as output properties. Additionally, the Invite 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 Invite Resource

Get an existing Invite 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?: InviteState, opts?: CustomResourceOptions): Invite
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email_accounts: Optional[Sequence[InviteEmailAccountArgs]] = None,
        invite_id: Optional[str] = None,
        team: Optional[str] = None) -> Invite
func GetInvite(ctx *Context, name string, id IDInput, state *InviteState, opts ...ResourceOption) (*Invite, error)
public static Invite Get(string name, Input<string> id, InviteState? state, CustomResourceOptions? opts = null)
public static Invite get(String name, Output<String> id, InviteState state, CustomResourceOptions options)
resources:  _:    type: zenduty:Invite    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Supporting Types

InviteEmailAccount
, InviteEmailAccountArgs

Email This property is required. string
FirstName This property is required. string
LastName This property is required. string
Role This property is required. double
Email This property is required. string
FirstName This property is required. string
LastName This property is required. string
Role This property is required. float64
email This property is required. String
firstName This property is required. String
lastName This property is required. String
role This property is required. Double
email This property is required. string
firstName This property is required. string
lastName This property is required. string
role This property is required. number
email This property is required. str
first_name This property is required. str
last_name This property is required. str
role This property is required. float
email This property is required. String
firstName This property is required. String
lastName This property is required. String
role This property is required. Number

Package Details

Repository
zenduty zenduty/terraform-provider-zenduty
License
Notes
This Pulumi package is based on the zenduty Terraform Provider.