1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. workstations
  5. WorkstationConfigIamPolicy
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.workstations.WorkstationConfigIamPolicy

Explore with Pulumi AI

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}}

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

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

  • {{workstation_config_id}}

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

Cloud Workstations workstationconfig 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/workstationConfigIamPolicy:WorkstationConfigIamPolicy editor "projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}} roles/viewer user:jane@example.com"
Copy

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

$ pulumi import gcp:workstations/workstationConfigIamPolicy:WorkstationConfigIamPolicy editor "projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}} roles/viewer"
Copy

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

$ pulumi import gcp:workstations/workstationConfigIamPolicy:WorkstationConfigIamPolicy editor projects/{{project}}/locations/{{location}}/workstationClusters/{{workstation_cluster_id}}/workstationConfigs/{{workstation_config_id}}
Copy

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

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

Constructor syntax

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

@overload
def WorkstationConfigIamPolicy(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               policy_data: Optional[str] = None,
                               workstation_cluster_id: Optional[str] = None,
                               workstation_config_id: Optional[str] = None,
                               location: Optional[str] = None,
                               project: Optional[str] = None)
func NewWorkstationConfigIamPolicy(ctx *Context, name string, args WorkstationConfigIamPolicyArgs, opts ...ResourceOption) (*WorkstationConfigIamPolicy, error)
public WorkstationConfigIamPolicy(string name, WorkstationConfigIamPolicyArgs args, CustomResourceOptions? opts = null)
public WorkstationConfigIamPolicy(String name, WorkstationConfigIamPolicyArgs args)
public WorkstationConfigIamPolicy(String name, WorkstationConfigIamPolicyArgs args, CustomResourceOptions options)
type: gcp:workstations:WorkstationConfigIamPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkstationConfigIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkstationConfigIamPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkstationConfigIamPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkstationConfigIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkstationConfigIamPolicyArgs
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 workstationConfigIamPolicyResource = new Gcp.Workstations.WorkstationConfigIamPolicy("workstationConfigIamPolicyResource", new()
{
    PolicyData = "string",
    WorkstationClusterId = "string",
    WorkstationConfigId = "string",
    Location = "string",
    Project = "string",
});
Copy
example, err := workstations.NewWorkstationConfigIamPolicy(ctx, "workstationConfigIamPolicyResource", &workstations.WorkstationConfigIamPolicyArgs{
	PolicyData:           pulumi.String("string"),
	WorkstationClusterId: pulumi.String("string"),
	WorkstationConfigId:  pulumi.String("string"),
	Location:             pulumi.String("string"),
	Project:              pulumi.String("string"),
})
Copy
var workstationConfigIamPolicyResource = new WorkstationConfigIamPolicy("workstationConfigIamPolicyResource", WorkstationConfigIamPolicyArgs.builder()
    .policyData("string")
    .workstationClusterId("string")
    .workstationConfigId("string")
    .location("string")
    .project("string")
    .build());
Copy
workstation_config_iam_policy_resource = gcp.workstations.WorkstationConfigIamPolicy("workstationConfigIamPolicyResource",
    policy_data="string",
    workstation_cluster_id="string",
    workstation_config_id="string",
    location="string",
    project="string")
Copy
const workstationConfigIamPolicyResource = new gcp.workstations.WorkstationConfigIamPolicy("workstationConfigIamPolicyResource", {
    policyData: "string",
    workstationClusterId: "string",
    workstationConfigId: "string",
    location: "string",
    project: "string",
});
Copy
type: gcp:workstations:WorkstationConfigIamPolicy
properties:
    location: string
    policyData: string
    project: string
    workstationClusterId: string
    workstationConfigId: string
Copy

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

PolicyData This property is required. string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
WorkstationClusterId
This property is required.
Changes to this property will trigger replacement.
string
WorkstationConfigId
This property is required.
Changes to this property will trigger replacement.
string
Location Changes to this property will trigger replacement. string
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
Project Changes to this property will trigger replacement. 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 This property is required. string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
WorkstationClusterId
This property is required.
Changes to this property will trigger replacement.
string
WorkstationConfigId
This property is required.
Changes to this property will trigger replacement.
string
Location Changes to this property will trigger replacement. string
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
Project Changes to this property will trigger replacement. 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 This property is required. String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
workstationClusterId
This property is required.
Changes to this property will trigger replacement.
String
workstationConfigId
This property is required.
Changes to this property will trigger replacement.
String
location Changes to this property will trigger replacement. String
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
project Changes to this property will trigger replacement. 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 This property is required. string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
workstationClusterId
This property is required.
Changes to this property will trigger replacement.
string
workstationConfigId
This property is required.
Changes to this property will trigger replacement.
string
location Changes to this property will trigger replacement. string
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
project Changes to this property will trigger replacement. 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 This property is required. str
The policy data generated by a gcp.organizations.getIAMPolicy data source.
workstation_cluster_id
This property is required.
Changes to this property will trigger replacement.
str
workstation_config_id
This property is required.
Changes to this property will trigger replacement.
str
location Changes to this property will trigger replacement. str
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
project Changes to this property will trigger replacement. 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 This property is required. String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
workstationClusterId
This property is required.
Changes to this property will trigger replacement.
String
workstationConfigId
This property is required.
Changes to this property will trigger replacement.
String
location Changes to this property will trigger replacement. String
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
project Changes to this property will trigger replacement. 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 WorkstationConfigIamPolicy 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 WorkstationConfigIamPolicy Resource

Get an existing WorkstationConfigIamPolicy 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?: WorkstationConfigIamPolicyState, opts?: CustomResourceOptions): WorkstationConfigIamPolicy
@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) -> WorkstationConfigIamPolicy
func GetWorkstationConfigIamPolicy(ctx *Context, name string, id IDInput, state *WorkstationConfigIamPolicyState, opts ...ResourceOption) (*WorkstationConfigIamPolicy, error)
public static WorkstationConfigIamPolicy Get(string name, Input<string> id, WorkstationConfigIamPolicyState? state, CustomResourceOptions? opts = null)
public static WorkstationConfigIamPolicy get(String name, Output<String> id, WorkstationConfigIamPolicyState state, CustomResourceOptions options)
resources:  _:    type: gcp:workstations:WorkstationConfigIamPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
PolicyData string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
WorkstationConfigId Changes to this property will trigger replacement. string
Etag string
(Computed) The etag of the IAM policy.
Location Changes to this property will trigger replacement. string
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
PolicyData string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
WorkstationConfigId Changes to this property will trigger replacement. string
etag String
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. String
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
policyData String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
workstationConfigId Changes to this property will trigger replacement. String
etag string
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. string
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
policyData string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
workstationConfigId Changes to this property will trigger replacement. string
etag str
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. str
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
policy_data str
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
workstation_config_id Changes to this property will trigger replacement. str
etag String
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. String
The location where the workstation cluster config should reside. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
policyData String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
workstationConfigId Changes to this property will trigger replacement. 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.