Grafana v0.7.0, Nov 5 24

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

grafana.cloud.OrgMember

Explore with Pulumi AI

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

Create OrgMember Resource

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

Constructor syntax

new OrgMember(name: string, args: OrgMemberArgs, opts?: CustomResourceOptions);

@overload
def OrgMember(resource_name: str,
              args: OrgMemberArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def OrgMember(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 NewOrgMember(ctx *Context, name string, args OrgMemberArgs, opts ...ResourceOption) (*OrgMember, error)

public OrgMember(string name, OrgMemberArgs args, CustomResourceOptions? opts = null)

public OrgMember(String name, OrgMemberArgs args)
public OrgMember(String name, OrgMemberArgs args, CustomResourceOptions options)

type: grafana:cloud:OrgMember
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 OrgMemberArgs: 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 OrgMemberArgs: 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 OrgMemberArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OrgMemberArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OrgMemberArgs: 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 orgMemberResource = new Grafana.Cloud.OrgMember("orgMemberResource", new()
{
    Org = "string",
    Role = "string",
    User = "string",
    ReceiveBillingEmails = false,
});

example, err := cloud.NewOrgMember(ctx, "orgMemberResource", &cloud.OrgMemberArgs{
	Org:                  pulumi.String("string"),
	Role:                 pulumi.String("string"),
	User:                 pulumi.String("string"),
	ReceiveBillingEmails: pulumi.Bool(false),
})

var orgMemberResource = new OrgMember("orgMemberResource", OrgMemberArgs.builder()
    .org("string")
    .role("string")
    .user("string")
    .receiveBillingEmails(false)
    .build());

org_member_resource = grafana.cloud.OrgMember("orgMemberResource",
    org="string",
    role="string",
    user="string",
    receive_billing_emails=False)

const orgMemberResource = new grafana.cloud.OrgMember("orgMemberResource", {
    org: "string",
    role: "string",
    user: "string",
    receiveBillingEmails: false,
});

type: grafana:cloud:OrgMember
properties:
    org: string
    receiveBillingEmails: false
    role: string
    user: string

OrgMember 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 OrgMember 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 OrgMember 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 OrgMember Resource

Get an existing OrgMember 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?: OrgMemberState, opts?: CustomResourceOptions): OrgMember

@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) -> OrgMember

func GetOrgMember(ctx *Context, name string, id IDInput, state *OrgMemberState, opts ...ResourceOption) (*OrgMember, error)

public static OrgMember Get(string name, Input<string> id, OrgMemberState? state, CustomResourceOptions? opts = null)

public static OrgMember get(String name, Output<String> id, OrgMemberState 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:cloud/orgMember:OrgMember 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 v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

pulumiverse/pulumi-grafana

grafana.cloud.OrgMember

On this page

On this page

Create OrgMember Resource

Constructor syntax

Parameters

Constructor example

OrgMember Resource Properties

Inputs

Outputs

Look up Existing OrgMember Resource

Import

Package Details

On this page

On this page