Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. RoleAssignment
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.RoleAssignment

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

    Example Usage

    Create RoleAssignment Resource

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

    Constructor syntax

    new RoleAssignment(name: string, args: RoleAssignmentArgs, opts?: CustomResourceOptions);
    @overload
def RoleAssignment(resource_name: str,
                   args: RoleAssignmentArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def RoleAssignment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   assigned_to: Optional[str] = None,
                   role_id: Optional[str] = None,
                   org_unit_id: Optional[str] = None,
                   scope_type: Optional[str] = None)
    func NewRoleAssignment(ctx *Context, name string, args RoleAssignmentArgs, opts ...ResourceOption) (*RoleAssignment, error)
    public RoleAssignment(string name, RoleAssignmentArgs args, CustomResourceOptions? opts = null)
    public RoleAssignment(String name, RoleAssignmentArgs args)
public RoleAssignment(String name, RoleAssignmentArgs args, CustomResourceOptions options)

    type: googleworkspace:RoleAssignment
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 RoleAssignmentArgs
    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 RoleAssignmentArgs
    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 RoleAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleAssignmentArgs
    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 roleAssignmentResource = new Googleworkspace.RoleAssignment("roleAssignmentResource", new()
{
    AssignedTo = "string",
    RoleId = "string",
    OrgUnitId = "string",
    ScopeType = "string",
});

    example, err := googleworkspace.NewRoleAssignment(ctx, "roleAssignmentResource", &googleworkspace.RoleAssignmentArgs{
AssignedTo: pulumi.String("string"),
RoleId: pulumi.String("string"),
OrgUnitId: pulumi.String("string"),
ScopeType: pulumi.String("string"),
})

    var roleAssignmentResource = new RoleAssignment("roleAssignmentResource", RoleAssignmentArgs.builder()
    .assignedTo("string")
    .roleId("string")
    .orgUnitId("string")
    .scopeType("string")
    .build());

    role_assignment_resource = googleworkspace.RoleAssignment("roleAssignmentResource",
    assigned_to="string",
    role_id="string",
    org_unit_id="string",
    scope_type="string")

    const roleAssignmentResource = new googleworkspace.RoleAssignment("roleAssignmentResource", {
    assignedTo: "string",
    roleId: "string",
    orgUnitId: "string",
    scopeType: "string",
});

    type: googleworkspace:RoleAssignment
properties:
    assignedTo: string
    orgUnitId: string
    roleId: string
    scopeType: string

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

    AssignedTo string
    The unique ID of the user this role is assigned to.
    RoleId string
    The ID of the role that is assigned.
    OrgUnitId string
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    ScopeType string
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    AssignedTo string
    The unique ID of the user this role is assigned to.
    RoleId string
    The ID of the role that is assigned.
    OrgUnitId string
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    ScopeType string
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assignedTo String
    The unique ID of the user this role is assigned to.
    roleId String
    The ID of the role that is assigned.
    orgUnitId String
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    scopeType String
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assignedTo string
    The unique ID of the user this role is assigned to.
    roleId string
    The ID of the role that is assigned.
    orgUnitId string
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    scopeType string
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assigned_to str
    The unique ID of the user this role is assigned to.
    role_id str
    The ID of the role that is assigned.
    org_unit_id str
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    scope_type str
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assignedTo String
    The unique ID of the user this role is assigned to.
    roleId String
    The ID of the role that is assigned.
    orgUnitId String
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    scopeType String
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT

    Outputs

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

    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    etag string
    ETag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    etag str
    ETag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RoleAssignment Resource

    Get an existing RoleAssignment 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?: RoleAssignmentState, opts?: CustomResourceOptions): RoleAssignment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assigned_to: Optional[str] = None,
        etag: Optional[str] = None,
        org_unit_id: Optional[str] = None,
        role_id: Optional[str] = None,
        scope_type: Optional[str] = None) -> RoleAssignment
    func GetRoleAssignment(ctx *Context, name string, id IDInput, state *RoleAssignmentState, opts ...ResourceOption) (*RoleAssignment, error)
    public static RoleAssignment Get(string name, Input<string> id, RoleAssignmentState? state, CustomResourceOptions? opts = null)
    public static RoleAssignment get(String name, Output<String> id, RoleAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: googleworkspace:RoleAssignment    get:      id: ${id}
    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:
    AssignedTo string
    The unique ID of the user this role is assigned to.
    Etag string
    ETag of the resource.
    OrgUnitId string
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    RoleId string
    The ID of the role that is assigned.
    ScopeType string
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    AssignedTo string
    The unique ID of the user this role is assigned to.
    Etag string
    ETag of the resource.
    OrgUnitId string
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    RoleId string
    The ID of the role that is assigned.
    ScopeType string
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assignedTo String
    The unique ID of the user this role is assigned to.
    etag String
    ETag of the resource.
    orgUnitId String
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    roleId String
    The ID of the role that is assigned.
    scopeType String
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assignedTo string
    The unique ID of the user this role is assigned to.
    etag string
    ETag of the resource.
    orgUnitId string
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    roleId string
    The ID of the role that is assigned.
    scopeType string
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assigned_to str
    The unique ID of the user this role is assigned to.
    etag str
    ETag of the resource.
    org_unit_id str
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    role_id str
    The ID of the role that is assigned.
    scope_type str
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT
    assignedTo String
    The unique ID of the user this role is assigned to.
    etag String
    ETag of the resource.
    orgUnitId String
    If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    roleId String
    The ID of the role that is assigned.
    scopeType String
    Defaults to CUSTOMER. The scope in which this role is assigned. Valid values are : - CUSTOMER - ORG_UNIT

    Import

    $ pulumi import googleworkspace:index/roleAssignment:RoleAssignment dwight 12345678901234567

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

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
    hashicorp/terraform-provider-googleworkspace