Confluent v2.10.0, Nov 20 24

Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

confluentcloud.getInvitation

Explore with Pulumi AI

Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

Example Usage

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

const main = confluentcloud.getInvitation({
    id: "i-gxxn1",
});
export const invitation = main;

import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_invitation(id="i-gxxn1")
pulumi.export("invitation", main)

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 {
		main, err := confluentcloud.LookupInvitation(ctx, &confluentcloud.LookupInvitationArgs{
			Id: "i-gxxn1",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("invitation", main)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var main = ConfluentCloud.GetInvitation.Invoke(new()
    {
        Id = "i-gxxn1",
    });

    return new Dictionary<string, object?>
    {
        ["invitation"] = main,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetInvitationArgs;
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) {
        final var main = ConfluentcloudFunctions.getInvitation(GetInvitationArgs.builder()
            .id("i-gxxn1")
            .build());

        ctx.export("invitation", main.applyValue(getInvitationResult -> getInvitationResult));
    }
}

variables:
  main:
    fn::invoke:
      Function: confluentcloud:getInvitation
      Arguments:
        id: i-gxxn1
outputs:
  invitation: ${main}

Using getInvitation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInvitation(args: GetInvitationArgs, opts?: InvokeOptions): Promise<GetInvitationResult>
function getInvitationOutput(args: GetInvitationOutputArgs, opts?: InvokeOptions): Output<GetInvitationResult>

def get_invitation(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetInvitationResult
def get_invitation_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetInvitationResult]

func LookupInvitation(ctx *Context, args *LookupInvitationArgs, opts ...InvokeOption) (*LookupInvitationResult, error)
func LookupInvitationOutput(ctx *Context, args *LookupInvitationOutputArgs, opts ...InvokeOption) LookupInvitationResultOutput

> Note: This function is named LookupInvitation in the Go SDK.

public static class GetInvitation 
{
    public static Task<GetInvitationResult> InvokeAsync(GetInvitationArgs args, InvokeOptions? opts = null)
    public static Output<GetInvitationResult> Invoke(GetInvitationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInvitationResult> getInvitation(GetInvitationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: confluentcloud:index/getInvitation:getInvitation
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID of the Invitation, for example, i-zyw30.

Id string: The ID of the Invitation, for example, i-zyw30.

id String: The ID of the Invitation, for example, i-zyw30.

id string: The ID of the Invitation, for example, i-zyw30.

id str: The ID of the Invitation, for example, i-zyw30.

id String: The ID of the Invitation, for example, i-zyw30.

getInvitation Result

The following output properties are available:

AcceptedAt string: (Optional String) The timestamp that the invitation was accepted.
AuthType string: (Optional 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.Outputs.GetInvitationCreator>: (Required Configuration Block) supports the following:
Email string: (Required String) The user/invitee's email address.
ExpiresAt string: (Optional String) The timestamp that the invitation will expire.
Id string: (Required String) The id of invitation creator.
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.GetInvitationUser>: (Required Configuration Block) supports the following:

AcceptedAt string: (Optional String) The timestamp that the invitation was accepted.
AuthType string: (Optional 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 []GetInvitationCreator: (Required Configuration Block) supports the following:
Email string: (Required String) The user/invitee's email address.
ExpiresAt string: (Optional String) The timestamp that the invitation will expire.
Id string: (Required String) The id of invitation creator.
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 []GetInvitationUser: (Required Configuration Block) supports the following:

acceptedAt String: (Optional String) The timestamp that the invitation was accepted.
authType String: (Optional 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<GetInvitationCreator>: (Required Configuration Block) supports the following:
email String: (Required String) The user/invitee's email address.
expiresAt String: (Optional String) The timestamp that the invitation will expire.
id String: (Required String) The id of invitation creator.
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<GetInvitationUser>: (Required Configuration Block) supports the following:

acceptedAt string: (Optional String) The timestamp that the invitation was accepted.
authType string: (Optional 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 GetInvitationCreator[]: (Required Configuration Block) supports the following:
email string: (Required String) The user/invitee's email address.
expiresAt string: (Optional String) The timestamp that the invitation will expire.
id string: (Required String) The id of invitation creator.
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 GetInvitationUser[]: (Required Configuration Block) supports the following:

accepted_at str: (Optional String) The timestamp that the invitation was accepted.
auth_type str: (Optional 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 Sequence[GetInvitationCreator]: (Required Configuration Block) supports the following:
email str: (Required String) The user/invitee's email address.
expires_at str: (Optional String) The timestamp that the invitation will expire.
id str: (Required String) The id of invitation creator.
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[GetInvitationUser]: (Required Configuration Block) supports the following:

acceptedAt String: (Optional String) The timestamp that the invitation was accepted.
authType String: (Optional 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: (Required String) The user/invitee's email address.
expiresAt String: (Optional String) The timestamp that the invitation will expire.
id String: (Required String) The id of invitation creator.
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

GetInvitationCreator

Id string: The ID of the Invitation, for example, i-zyw30.

Id string: The ID of the Invitation, for example, i-zyw30.

id String: The ID of the Invitation, for example, i-zyw30.

id string: The ID of the Invitation, for example, i-zyw30.

id str: The ID of the Invitation, for example, i-zyw30.

id String: The ID of the Invitation, for example, i-zyw30.

GetInvitationUser

Id string: The ID of the Invitation, for example, i-zyw30.

Id string: The ID of the Invitation, for example, i-zyw30.

id String: The ID of the Invitation, for example, i-zyw30.

id string: The ID of the Invitation, for example, i-zyw30.

id str: The ID of the Invitation, for example, i-zyw30.

id String: The ID of the Invitation, for example, i-zyw30.

Package Details

Repository: Confluent Cloud pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.

Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-confluentcloud

confluentcloud.getInvitation

On this page

On this page

Example Usage

Using getInvitation

getInvitation Result

Supporting Types

GetInvitationCreator

GetInvitationUser

Package Details

On this page

On this page