Docs
PackagesAiven v6.13.0 published on Monday, Mar 25, 2024 by Pulumi
aiven.OrganizationUser
Explore with Pulumi AI
This resource is deprecated. Use the aiven.OrganizationUser data source instead.
The organization user resource allows the creation and management of an Aiven organization user.
During the creation of aiven.OrganizationUserresource, an email invitation will be sent
to a user using user_email address. If the user accepts an invitation, they will become
a member of the organization. The deletion of aiven.OrganizationUser will not only
delete the invitation if one was sent but not yet accepted by the user, it will also
eliminate the member from the organization if one has accepted an invitation previously.
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.
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
The OrganizationUser resource accepts the following input properties:
- Organization
Id string - The unique organization ID. Changing this property forces recreation of the resource.
- User
Email 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 string - The unique organization ID. Changing this property forces recreation of the resource.
- User
Email 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 String - The unique organization ID. Changing this property forces recreation of the resource.
- user
Email 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 string - The unique organization ID. Changing this property forces recreation of the resource.
- user
Email 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.
- organization
Id String - The unique organization ID. Changing this property forces recreation of the resource.
- user
Email 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - Create
Time string - Time of creation
- Id string
- The provider-assigned unique ID for this managed resource.
- Invited
By string - The email address of the user who sent an invitation to the user.
- User
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - Create
Time string - Time of creation
- Id string
- The provider-assigned unique ID for this managed resource.
- Invited
By string - The email address of the user who sent an invitation to the user.
- User
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create
Time String - Time of creation
- id String
- The provider-assigned unique ID for this managed resource.
- invited
By String - The email address of the user who sent an invitation to the user.
- user
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create
Time string - Time of creation
- id string
- The provider-assigned unique ID for this managed resource.
- invited
By string - The email address of the user who sent an invitation to the user.
- user
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - 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.
- 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create
Time String - Time of creation
- id String
- The provider-assigned unique ID for this managed resource.
- invited
By String - The email address of the user who sent an invitation to the user.
- user
Id 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) -> OrganizationUserfunc 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.
- Accepted bool
- This is a boolean flag that determines whether an invitation was accepted or not by the user.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - Create
Time string - Time of creation
- Invited
By string - The email address of the user who sent an invitation to the user.
- Organization
Id string - The unique organization ID. Changing this property forces recreation of the resource.
- User
Email 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.
- User
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - Create
Time string - Time of creation
- Invited
By string - The email address of the user who sent an invitation to the user.
- Organization
Id string - The unique organization ID. Changing this property forces recreation of the resource.
- User
Email 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.
- User
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create
Time String - Time of creation
- invited
By String - The email address of the user who sent an invitation to the user.
- organization
Id String - The unique organization ID. Changing this property forces recreation of the resource.
- user
Email 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.
- user
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create
Time string - Time of creation
- invited
By string - The email address of the user who sent an invitation to the user.
- organization
Id string - The unique organization ID. Changing this property forces recreation of the resource.
- user
Email 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.
- user
Id 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create_
time str - Time of creation
- invited_
by str - The email address of the user who sent an invitation to the user.
- 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.
falsevalue means that the invitation was sent to the user but not yet accepted.truemeans that the user accepted the invitation and now a member of an organization. - create
Time String - Time of creation
- invited
By String - The email address of the user who sent an invitation to the user.
- organization
Id String - The unique organization ID. Changing this property forces recreation of the resource.
- user
Email 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.
- user
Id 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
aivenTerraform Provider.