Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. Invitation
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.Invitation

Explore with Pulumi AI

confluentcloud logo
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.Invitation provides an invitation resource that enables creating, reading, and deleting invitation on Confluent Cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

const main = new confluentcloud.Invitation("main", {email: ""});
const main2 = new confluentcloud.Invitation("main2", {
    email: "",
    authType: "AUTH_TYPE_LOCAL",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.Invitation("main", email="")
main2 = confluentcloud.Invitation("main2",
    email="",
    auth_type="AUTH_TYPE_LOCAL")

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := confluentcloud.NewInvitation(ctx, "main", &confluentcloud.InvitationArgs{
			Email: pulumi.String(""),
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewInvitation(ctx, "main2", &confluentcloud.InvitationArgs{
			Email:    pulumi.String(""),
			AuthType: pulumi.String("AUTH_TYPE_LOCAL"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var main = new ConfluentCloud.Invitation("main", new()
    {
        Email = "",
    });

    var main2 = new ConfluentCloud.Invitation("main2", new()
    {
        Email = "",
        AuthType = "AUTH_TYPE_LOCAL",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Invitation;
import com.pulumi.confluentcloud.InvitationArgs;
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 main = new Invitation("main", InvitationArgs.builder()
            .email("")
            .build());

        var main2 = new Invitation("main2", InvitationArgs.builder()
            .email("")
            .authType("AUTH_TYPE_LOCAL")
            .build());

    }
}

    resources:
  main:
    type: confluentcloud:Invitation
    properties:
      email:
  main2:
    type: confluentcloud:Invitation
    properties:
      email:
      authType: AUTH_TYPE_LOCAL

    Create Invitation Resource

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

    Constructor syntax

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

@overload
def Invitation(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               email: Optional[str] = None,
               allow_deletion: Optional[bool] = None,
               auth_type: Optional[str] = None)
    func NewInvitation(ctx *Context, name string, args InvitationArgs, opts ...ResourceOption) (*Invitation, error)
    public Invitation(string name, InvitationArgs args, CustomResourceOptions? opts = null)
    public Invitation(String name, InvitationArgs args)
public Invitation(String name, InvitationArgs args, CustomResourceOptions options)

    type: confluentcloud:Invitation
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 InvitationArgs
    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 InvitationArgs
    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 InvitationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InvitationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InvitationArgs
    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 invitationResource = new ConfluentCloud.Invitation("invitationResource", new()
{
    Email = "string",
    AllowDeletion = false,
    AuthType = "string",
});

    example, err := confluentcloud.NewInvitation(ctx, "invitationResource", &confluentcloud.InvitationArgs{
	Email:         pulumi.String("string"),
	AllowDeletion: pulumi.Bool(false),
	AuthType:      pulumi.String("string"),
})

    var invitationResource = new Invitation("invitationResource", InvitationArgs.builder()
    .email("string")
    .allowDeletion(false)
    .authType("string")
    .build());

    invitation_resource = confluentcloud.Invitation("invitationResource",
    email="string",
    allow_deletion=False,
    auth_type="string")

    const invitationResource = new confluentcloud.Invitation("invitationResource", {
    email: "string",
    allowDeletion: false,
    authType: "string",
});

    type: confluentcloud:Invitation
properties:
    allowDeletion: false
    authType: string
    email: string

    Invitation 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 Invitation resource accepts the following input properties:

    Email string
    The user/invitee's email address.
    AllowDeletion bool
    AuthType string
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    Email string
    The user/invitee's email address.
    AllowDeletion bool
    AuthType string
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    email String
    The user/invitee's email address.
    allowDeletion Boolean
    authType String
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    email string
    The user/invitee's email address.
    allowDeletion boolean
    authType string
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    email str
    The user/invitee's email address.
    allow_deletion bool
    auth_type str
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    email String
    The user/invitee's email address.
    allowDeletion Boolean
    authType String
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.

    Outputs

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

    AcceptedAt string
    (Optional String) The timestamp that the invitation was accepted.
    Creators List<Pulumi.ConfluentCloud.Outputs.InvitationCreator>
    (Required Configuration Block) supports the following:
    ExpiresAt string
    (Optional String) The timestamp that the invitation will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    Users List<Pulumi.ConfluentCloud.Outputs.InvitationUser>
    (Required Configuration Block) supports the following:
    AcceptedAt string
    (Optional String) The timestamp that the invitation was accepted.
    Creators []InvitationCreator
    (Required Configuration Block) supports the following:
    ExpiresAt string
    (Optional String) The timestamp that the invitation will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    Users []InvitationUser
    (Required Configuration Block) supports the following:
    acceptedAt String
    (Optional String) The timestamp that the invitation was accepted.
    creators List<InvitationCreator>
    (Required Configuration Block) supports the following:
    expiresAt String
    (Optional String) The timestamp that the invitation will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users List<InvitationUser>
    (Required Configuration Block) supports the following:
    acceptedAt string
    (Optional String) The timestamp that the invitation was accepted.
    creators InvitationCreator[]
    (Required Configuration Block) supports the following:
    expiresAt string
    (Optional String) The timestamp that the invitation will expire.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users InvitationUser[]
    (Required Configuration Block) supports the following:
    accepted_at str
    (Optional String) The timestamp that the invitation was accepted.
    creators Sequence[InvitationCreator]
    (Required Configuration Block) supports the following:
    expires_at str
    (Optional String) The timestamp that the invitation will expire.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users Sequence[InvitationUser]
    (Required Configuration Block) supports the following:
    acceptedAt String
    (Optional String) The timestamp that the invitation was accepted.
    creators List<Property Map>
    (Required Configuration Block) supports the following:
    expiresAt String
    (Optional String) The timestamp that the invitation will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users List<Property Map>
    (Required Configuration Block) supports the following:

    Look up Existing Invitation Resource

    Get an existing Invitation 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?: InvitationState, opts?: CustomResourceOptions): Invitation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accepted_at: Optional[str] = None,
        allow_deletion: Optional[bool] = None,
        auth_type: Optional[str] = None,
        creators: Optional[Sequence[InvitationCreatorArgs]] = None,
        email: Optional[str] = None,
        expires_at: Optional[str] = None,
        status: Optional[str] = None,
        users: Optional[Sequence[InvitationUserArgs]] = None) -> Invitation
    func GetInvitation(ctx *Context, name string, id IDInput, state *InvitationState, opts ...ResourceOption) (*Invitation, error)
    public static Invitation Get(string name, Input<string> id, InvitationState? state, CustomResourceOptions? opts = null)
    public static Invitation get(String name, Output<String> id, InvitationState 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:
    AcceptedAt string
    (Optional String) The timestamp that the invitation was accepted.
    AllowDeletion bool
    AuthType string
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    Creators List<Pulumi.ConfluentCloud.Inputs.InvitationCreator>
    (Required Configuration Block) supports the following:
    Email string
    The user/invitee's email address.
    ExpiresAt string
    (Optional String) The timestamp that the invitation will expire.
    Status string
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    Users List<Pulumi.ConfluentCloud.Inputs.InvitationUser>
    (Required Configuration Block) supports the following:
    AcceptedAt string
    (Optional String) The timestamp that the invitation was accepted.
    AllowDeletion bool
    AuthType string
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    Creators []InvitationCreatorArgs
    (Required Configuration Block) supports the following:
    Email string
    The user/invitee's email address.
    ExpiresAt string
    (Optional String) The timestamp that the invitation will expire.
    Status string
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    Users []InvitationUserArgs
    (Required Configuration Block) supports the following:
    acceptedAt String
    (Optional String) The timestamp that the invitation was accepted.
    allowDeletion Boolean
    authType String
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    creators List<InvitationCreator>
    (Required Configuration Block) supports the following:
    email String
    The user/invitee's email address.
    expiresAt String
    (Optional String) The timestamp that the invitation will expire.
    status String
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users List<InvitationUser>
    (Required Configuration Block) supports the following:
    acceptedAt string
    (Optional String) The timestamp that the invitation was accepted.
    allowDeletion boolean
    authType string
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    creators InvitationCreator[]
    (Required Configuration Block) supports the following:
    email string
    The user/invitee's email address.
    expiresAt string
    (Optional String) The timestamp that the invitation will expire.
    status string
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users InvitationUser[]
    (Required Configuration Block) supports the following:
    accepted_at str
    (Optional String) The timestamp that the invitation was accepted.
    allow_deletion bool
    auth_type str
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    creators Sequence[InvitationCreatorArgs]
    (Required Configuration Block) supports the following:
    email str
    The user/invitee's email address.
    expires_at str
    (Optional String) The timestamp that the invitation will expire.
    status str
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users Sequence[InvitationUserArgs]
    (Required Configuration Block) supports the following:
    acceptedAt String
    (Optional String) The timestamp that the invitation was accepted.
    allowDeletion Boolean
    authType String
    Accepted values are: AUTH_TYPE_LOCAL and AUTH_TYPE_SSO. The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.
    creators List<Property Map>
    (Required Configuration Block) supports the following:
    email String
    The user/invitee's email address.
    expiresAt String
    (Optional String) The timestamp that the invitation will expire.
    status String
    (Optional String) The status of invitations. Accepted values are: INVITE_STATUS_SENT,INVITE_STATUS_STAGED,INVITE_STATUS_ACCEPTED,INVITE_STATUS_EXPIRED, and INVITE_STATUS_DEACTIVATED.
    users List<Property Map>
    (Required Configuration Block) supports the following:

    Supporting Types

    InvitationCreator, InvitationCreatorArgs

    Id string
    (Required String) The id of invitation creator.
    Id string
    (Required String) The id of invitation creator.
    id String
    (Required String) The id of invitation creator.
    id string
    (Required String) The id of invitation creator.
    id str
    (Required String) The id of invitation creator.
    id String
    (Required String) The id of invitation creator.

    InvitationUser, InvitationUserArgs

    Id string
    (Required String) The id of invitation creator.
    Id string
    (Required String) The id of invitation creator.
    id String
    (Required String) The id of invitation creator.
    id string
    (Required String) The id of invitation creator.
    id str
    (Required String) The id of invitation creator.
    id String
    (Required String) The id of invitation creator.

    Import

    You can import an Invitation by using Invitation ID, for example:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/invitation:Invitation main i-gxxn1

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-confluentcloud