1. Packages
  2. Aiven Provider
  3. API Docs
  4. OrganizationUser
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi

aiven.OrganizationUser

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi

    Create OrganizationUser Resource

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

    Constructor syntax

    new OrganizationUser(name: string, args: OrganizationUserArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationUser(resource_name: str,
                         args: OrganizationUserArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrganizationUser(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         organization_id: Optional[str] = None,
                         user_email: Optional[str] = None)
    func NewOrganizationUser(ctx *Context, name string, args OrganizationUserArgs, opts ...ResourceOption) (*OrganizationUser, error)
    public OrganizationUser(string name, OrganizationUserArgs args, CustomResourceOptions? opts = null)
    public OrganizationUser(String name, OrganizationUserArgs args)
    public OrganizationUser(String name, OrganizationUserArgs args, CustomResourceOptions options)
    
    type: aiven:OrganizationUser
    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 OrganizationUserArgs
    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 OrganizationUserArgs
    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 OrganizationUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationUserArgs
    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 organizationUserResource = new Aiven.OrganizationUser("organizationUserResource", new()
    {
        OrganizationId = "string",
        UserEmail = "string",
    });
    
    example, err := aiven.NewOrganizationUser(ctx, "organizationUserResource", &aiven.OrganizationUserArgs{
    	OrganizationId: pulumi.String("string"),
    	UserEmail:      pulumi.String("string"),
    })
    
    var organizationUserResource = new OrganizationUser("organizationUserResource", OrganizationUserArgs.builder()
        .organizationId("string")
        .userEmail("string")
        .build());
    
    organization_user_resource = aiven.OrganizationUser("organizationUserResource",
        organization_id="string",
        user_email="string")
    
    const organizationUserResource = new aiven.OrganizationUser("organizationUserResource", {
        organizationId: "string",
        userEmail: "string",
    });
    
    type: aiven:OrganizationUser
    properties:
        organizationId: string
        userEmail: string
    

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

    OrganizationId string
    The unique organization ID. Changing this property forces recreation of the resource.
    UserEmail string
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    OrganizationId string
    The unique organization ID. Changing this property forces recreation of the resource.
    UserEmail string
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    organizationId String
    The unique organization ID. Changing this property forces recreation of the resource.
    userEmail String
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    organizationId string
    The unique organization ID. Changing this property forces recreation of the resource.
    userEmail string
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    organization_id str
    The unique organization ID. Changing this property forces recreation of the resource.
    user_email str
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    organizationId String
    The unique organization ID. Changing this property forces recreation of the resource.
    userEmail String
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.

    Outputs

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

    Accepted bool
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    CreateTime string
    Time of creation
    Id string
    The provider-assigned unique ID for this managed resource.
    InvitedBy string
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    UserId string
    The unique organization user ID
    Accepted bool
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    CreateTime string
    Time of creation
    Id string
    The provider-assigned unique ID for this managed resource.
    InvitedBy string
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    UserId string
    The unique organization user ID
    accepted Boolean
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    createTime String
    Time of creation
    id String
    The provider-assigned unique ID for this managed resource.
    invitedBy String
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    userId String
    The unique organization user ID
    accepted boolean
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    createTime string
    Time of creation
    id string
    The provider-assigned unique ID for this managed resource.
    invitedBy string
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    userId string
    The unique organization user ID
    accepted bool
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    create_time str
    Time of creation
    id str
    The provider-assigned unique ID for this managed resource.
    invited_by str
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    user_id str
    The unique organization user ID
    accepted Boolean
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    createTime String
    Time of creation
    id String
    The provider-assigned unique ID for this managed resource.
    invitedBy String
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    userId String
    The unique organization user ID

    Look up Existing OrganizationUser Resource

    Get an existing OrganizationUser 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?: OrganizationUserState, opts?: CustomResourceOptions): OrganizationUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accepted: Optional[bool] = None,
            create_time: Optional[str] = None,
            invited_by: Optional[str] = None,
            organization_id: Optional[str] = None,
            user_email: Optional[str] = None,
            user_id: Optional[str] = None) -> OrganizationUser
    func GetOrganizationUser(ctx *Context, name string, id IDInput, state *OrganizationUserState, opts ...ResourceOption) (*OrganizationUser, error)
    public static OrganizationUser Get(string name, Input<string> id, OrganizationUserState? state, CustomResourceOptions? opts = null)
    public static OrganizationUser get(String name, Output<String> id, OrganizationUserState 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:
    Accepted bool
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    CreateTime string
    Time of creation
    InvitedBy string
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    OrganizationId string
    The unique organization ID. Changing this property forces recreation of the resource.
    UserEmail string
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    UserId string
    The unique organization user ID
    Accepted bool
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    CreateTime string
    Time of creation
    InvitedBy string
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    OrganizationId string
    The unique organization ID. Changing this property forces recreation of the resource.
    UserEmail string
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    UserId string
    The unique organization user ID
    accepted Boolean
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    createTime String
    Time of creation
    invitedBy String
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    organizationId String
    The unique organization ID. Changing this property forces recreation of the resource.
    userEmail String
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    userId String
    The unique organization user ID
    accepted boolean
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    createTime string
    Time of creation
    invitedBy string
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    organizationId string
    The unique organization ID. Changing this property forces recreation of the resource.
    userEmail string
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    userId string
    The unique organization user ID
    accepted bool
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    create_time str
    Time of creation
    invited_by str
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    organization_id str
    The unique organization ID. Changing this property forces recreation of the resource.
    user_email str
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    user_id str
    The unique organization user ID
    accepted Boolean
    This is a boolean flag that determines whether an invitation was accepted or not by the user. false value means that the invitation was sent to the user but not yet accepted. true means that the user accepted the invitation and now a member of an organization.

    Deprecated: This field is deprecated and will be removed in the next major release.

    createTime String
    Time of creation
    invitedBy String
    The email address of the user who sent an invitation to the user.

    Deprecated: This field is deprecated and will be removed in the next major release.

    organizationId String
    The unique organization ID. Changing this property forces recreation of the resource.
    userEmail String
    This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource.
    userId String
    The unique organization user ID

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi