1. Packages
  2. Grafana Cloud
  3. API Docs
  4. CloudOrgMember
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

grafana.CloudOrgMember

Explore with Pulumi AI

grafana logo
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

    Manages the membership of a user in an organization.

    Create CloudOrgMember Resource

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

    Constructor syntax

    new CloudOrgMember(name: string, args: CloudOrgMemberArgs, opts?: CustomResourceOptions);
    @overload
    def CloudOrgMember(resource_name: str,
                       args: CloudOrgMemberArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudOrgMember(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       org: Optional[str] = None,
                       role: Optional[str] = None,
                       user: Optional[str] = None,
                       receive_billing_emails: Optional[bool] = None)
    func NewCloudOrgMember(ctx *Context, name string, args CloudOrgMemberArgs, opts ...ResourceOption) (*CloudOrgMember, error)
    public CloudOrgMember(string name, CloudOrgMemberArgs args, CustomResourceOptions? opts = null)
    public CloudOrgMember(String name, CloudOrgMemberArgs args)
    public CloudOrgMember(String name, CloudOrgMemberArgs args, CustomResourceOptions options)
    
    type: grafana:CloudOrgMember
    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 CloudOrgMemberArgs
    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 CloudOrgMemberArgs
    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 CloudOrgMemberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudOrgMemberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudOrgMemberArgs
    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 cloudOrgMemberResource = new Grafana.CloudOrgMember("cloudOrgMemberResource", new()
    {
        Org = "string",
        Role = "string",
        User = "string",
        ReceiveBillingEmails = false,
    });
    
    example, err := grafana.NewCloudOrgMember(ctx, "cloudOrgMemberResource", &grafana.CloudOrgMemberArgs{
    	Org:                  pulumi.String("string"),
    	Role:                 pulumi.String("string"),
    	User:                 pulumi.String("string"),
    	ReceiveBillingEmails: pulumi.Bool(false),
    })
    
    var cloudOrgMemberResource = new CloudOrgMember("cloudOrgMemberResource", CloudOrgMemberArgs.builder()
        .org("string")
        .role("string")
        .user("string")
        .receiveBillingEmails(false)
        .build());
    
    cloud_org_member_resource = grafana.CloudOrgMember("cloudOrgMemberResource",
        org="string",
        role="string",
        user="string",
        receive_billing_emails=False)
    
    const cloudOrgMemberResource = new grafana.CloudOrgMember("cloudOrgMemberResource", {
        org: "string",
        role: "string",
        user: "string",
        receiveBillingEmails: false,
    });
    
    type: grafana:CloudOrgMember
    properties:
        org: string
        receiveBillingEmails: false
        role: string
        user: string
    

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

    Org string
    The slug or ID of the organization.
    Role string
    The role to assign to the user in the organization.
    User string
    Username or ID of the user to add to the org's members.
    ReceiveBillingEmails bool
    Whether the user should receive billing emails.
    Org string
    The slug or ID of the organization.
    Role string
    The role to assign to the user in the organization.
    User string
    Username or ID of the user to add to the org's members.
    ReceiveBillingEmails bool
    Whether the user should receive billing emails.
    org String
    The slug or ID of the organization.
    role String
    The role to assign to the user in the organization.
    user String
    Username or ID of the user to add to the org's members.
    receiveBillingEmails Boolean
    Whether the user should receive billing emails.
    org string
    The slug or ID of the organization.
    role string
    The role to assign to the user in the organization.
    user string
    Username or ID of the user to add to the org's members.
    receiveBillingEmails boolean
    Whether the user should receive billing emails.
    org str
    The slug or ID of the organization.
    role str
    The role to assign to the user in the organization.
    user str
    Username or ID of the user to add to the org's members.
    receive_billing_emails bool
    Whether the user should receive billing emails.
    org String
    The slug or ID of the organization.
    role String
    The role to assign to the user in the organization.
    user String
    Username or ID of the user to add to the org's members.
    receiveBillingEmails Boolean
    Whether the user should receive billing emails.

    Outputs

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

    Get an existing CloudOrgMember 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?: CloudOrgMemberState, opts?: CustomResourceOptions): CloudOrgMember
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            org: Optional[str] = None,
            receive_billing_emails: Optional[bool] = None,
            role: Optional[str] = None,
            user: Optional[str] = None) -> CloudOrgMember
    func GetCloudOrgMember(ctx *Context, name string, id IDInput, state *CloudOrgMemberState, opts ...ResourceOption) (*CloudOrgMember, error)
    public static CloudOrgMember Get(string name, Input<string> id, CloudOrgMemberState? state, CustomResourceOptions? opts = null)
    public static CloudOrgMember get(String name, Output<String> id, CloudOrgMemberState 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:
    Org string
    The slug or ID of the organization.
    ReceiveBillingEmails bool
    Whether the user should receive billing emails.
    Role string
    The role to assign to the user in the organization.
    User string
    Username or ID of the user to add to the org's members.
    Org string
    The slug or ID of the organization.
    ReceiveBillingEmails bool
    Whether the user should receive billing emails.
    Role string
    The role to assign to the user in the organization.
    User string
    Username or ID of the user to add to the org's members.
    org String
    The slug or ID of the organization.
    receiveBillingEmails Boolean
    Whether the user should receive billing emails.
    role String
    The role to assign to the user in the organization.
    user String
    Username or ID of the user to add to the org's members.
    org string
    The slug or ID of the organization.
    receiveBillingEmails boolean
    Whether the user should receive billing emails.
    role string
    The role to assign to the user in the organization.
    user string
    Username or ID of the user to add to the org's members.
    org str
    The slug or ID of the organization.
    receive_billing_emails bool
    Whether the user should receive billing emails.
    role str
    The role to assign to the user in the organization.
    user str
    Username or ID of the user to add to the org's members.
    org String
    The slug or ID of the organization.
    receiveBillingEmails Boolean
    Whether the user should receive billing emails.
    role String
    The role to assign to the user in the organization.
    user String
    Username or ID of the user to add to the org's members.

    Import

    $ pulumi import grafana:index/cloudOrgMember:CloudOrgMember name "{{ orgSlugOrID }}:{{ usernameOrID }}"
    

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

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse