1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. workstations
  5. WorkstationIamPolicy
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi

gcp.workstations.WorkstationIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi

    Import

    For all import syntaxes, the “resource in question” can take any of the following forms:

    • projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}}/workstations/{{workstation_id}}

    • {{project}}/{{location}}/{{workstation_cluster_id}}/{{workstation_config_id}}/{{workstation_id}}

    • {{location}}/{{workstation_cluster_id}}/{{workstation_config_id}}/{{workstation_id}}

    • {{workstation_id}}

    Any variables not passed in the import command will be taken from the provider configuration.

    Cloud Workstations workstation IAM resources can be imported using the resource identifiers, role, and member.

    IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.

    $ pulumi import gcp:workstations/workstationIamPolicy:WorkstationIamPolicy editor "projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}}/workstations/{{workstation_id}} roles/viewer user:jane@example.com"
    

    IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

    $ pulumi import gcp:workstations/workstationIamPolicy:WorkstationIamPolicy editor "projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}}/workstations/{{workstation_id}} roles/viewer"
    

    IAM policy imports use the identifier of the resource in question, e.g.

    $ pulumi import gcp:workstations/workstationIamPolicy:WorkstationIamPolicy editor projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}}/workstations/{{workstation_id}}
    

    -> Custom Roles: If you’re importing a IAM resource with a custom role, make sure to use the

    full name of the custom role, e.g. [projects/my-project|organizations/my-org]/roles/my-custom-role.

    Create WorkstationIamPolicy Resource

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

    Constructor syntax

    new WorkstationIamPolicy(name: string, args: WorkstationIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def WorkstationIamPolicy(resource_name: str,
                             args: WorkstationIamPolicyArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkstationIamPolicy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             policy_data: Optional[str] = None,
                             workstation_cluster_id: Optional[str] = None,
                             workstation_config_id: Optional[str] = None,
                             workstation_id: Optional[str] = None,
                             location: Optional[str] = None,
                             project: Optional[str] = None)
    func NewWorkstationIamPolicy(ctx *Context, name string, args WorkstationIamPolicyArgs, opts ...ResourceOption) (*WorkstationIamPolicy, error)
    public WorkstationIamPolicy(string name, WorkstationIamPolicyArgs args, CustomResourceOptions? opts = null)
    public WorkstationIamPolicy(String name, WorkstationIamPolicyArgs args)
    public WorkstationIamPolicy(String name, WorkstationIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:workstations:WorkstationIamPolicy
    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 WorkstationIamPolicyArgs
    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 WorkstationIamPolicyArgs
    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 WorkstationIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkstationIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkstationIamPolicyArgs
    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 workstationIamPolicyResource = new Gcp.Workstations.WorkstationIamPolicy("workstationIamPolicyResource", new()
    {
        PolicyData = "string",
        WorkstationClusterId = "string",
        WorkstationConfigId = "string",
        WorkstationId = "string",
        Location = "string",
        Project = "string",
    });
    
    example, err := workstations.NewWorkstationIamPolicy(ctx, "workstationIamPolicyResource", &workstations.WorkstationIamPolicyArgs{
    	PolicyData:           pulumi.String("string"),
    	WorkstationClusterId: pulumi.String("string"),
    	WorkstationConfigId:  pulumi.String("string"),
    	WorkstationId:        pulumi.String("string"),
    	Location:             pulumi.String("string"),
    	Project:              pulumi.String("string"),
    })
    
    var workstationIamPolicyResource = new WorkstationIamPolicy("workstationIamPolicyResource", WorkstationIamPolicyArgs.builder()        
        .policyData("string")
        .workstationClusterId("string")
        .workstationConfigId("string")
        .workstationId("string")
        .location("string")
        .project("string")
        .build());
    
    workstation_iam_policy_resource = gcp.workstations.WorkstationIamPolicy("workstationIamPolicyResource",
        policy_data="string",
        workstation_cluster_id="string",
        workstation_config_id="string",
        workstation_id="string",
        location="string",
        project="string")
    
    const workstationIamPolicyResource = new gcp.workstations.WorkstationIamPolicy("workstationIamPolicyResource", {
        policyData: "string",
        workstationClusterId: "string",
        workstationConfigId: "string",
        workstationId: "string",
        location: "string",
        project: "string",
    });
    
    type: gcp:workstations:WorkstationIamPolicy
    properties:
        location: string
        policyData: string
        project: string
        workstationClusterId: string
        workstationConfigId: string
        workstationId: string
    

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

    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    WorkstationClusterId string
    WorkstationConfigId string
    WorkstationId string
    Location string
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    WorkstationClusterId string
    WorkstationConfigId string
    WorkstationId string
    Location string
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workstationClusterId String
    workstationConfigId String
    workstationId String
    location String
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workstationClusterId string
    workstationConfigId string
    workstationId string
    location string
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workstation_cluster_id str
    workstation_config_id str
    workstation_id str
    location str
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    workstationClusterId String
    workstationConfigId String
    workstationId String
    location String
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

    Outputs

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

    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    etag string
    (Computed) The etag of the IAM policy.
    id string
    The provider-assigned unique ID for this managed resource.
    etag str
    (Computed) The etag of the IAM policy.
    id str
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkstationIamPolicy Resource

    Get an existing WorkstationIamPolicy 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?: WorkstationIamPolicyState, opts?: CustomResourceOptions): WorkstationIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            etag: Optional[str] = None,
            location: Optional[str] = None,
            policy_data: Optional[str] = None,
            project: Optional[str] = None,
            workstation_cluster_id: Optional[str] = None,
            workstation_config_id: Optional[str] = None,
            workstation_id: Optional[str] = None) -> WorkstationIamPolicy
    func GetWorkstationIamPolicy(ctx *Context, name string, id IDInput, state *WorkstationIamPolicyState, opts ...ResourceOption) (*WorkstationIamPolicy, error)
    public static WorkstationIamPolicy Get(string name, Input<string> id, WorkstationIamPolicyState? state, CustomResourceOptions? opts = null)
    public static WorkstationIamPolicy get(String name, Output<String> id, WorkstationIamPolicyState 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:
    Etag string
    (Computed) The etag of the IAM policy.
    Location string
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    WorkstationClusterId string
    WorkstationConfigId string
    WorkstationId string
    Etag string
    (Computed) The etag of the IAM policy.
    Location string
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    WorkstationClusterId string
    WorkstationConfigId string
    WorkstationId string
    etag String
    (Computed) The etag of the IAM policy.
    location String
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workstationClusterId String
    workstationConfigId String
    workstationId String
    etag string
    (Computed) The etag of the IAM policy.
    location string
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workstationClusterId string
    workstationConfigId string
    workstationId string
    etag str
    (Computed) The etag of the IAM policy.
    location str
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workstation_cluster_id str
    workstation_config_id str
    workstation_id str
    etag String
    (Computed) The etag of the IAM policy.
    location String
    The location where the workstation parent resources reside. Used to find the parent resource to bind the IAM policy to
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    workstationClusterId String
    workstationConfigId String
    workstationId String

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi