1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudresourcemanager
  5. cloudresourcemanager/v1
  6. ProjectIamBinding

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.cloudresourcemanager/v1.ProjectIamBinding

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Sets the IAM access control policy for the specified Project. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. NOTE: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. For additional information about resource (e.g. my-project-id) structure and identification, see Resource Names. The following constraints apply when using setIamPolicy(): + Project does not support allUsers and allAuthenticatedUsers as members in a Binding of a Policy. + The owner role can be granted to a user, serviceAccount, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using setIamPolicy(). The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + You can only grant ownership of a project to a member by using the Google Cloud console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling setIamPolicy() to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. Authorization requires the Google IAM permission resourcemanager.projects.setIamPolicy on the project

Create ProjectIamBinding Resource

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

Constructor syntax

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

@overload
def ProjectIamBinding(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      members: Optional[Sequence[str]] = None,
                      name: Optional[str] = None,
                      role: Optional[str] = None,
                      condition: Optional[_iam.v1.ConditionArgs] = None)
func NewProjectIamBinding(ctx *Context, name string, args ProjectIamBindingArgs, opts ...ResourceOption) (*ProjectIamBinding, error)
public ProjectIamBinding(string name, ProjectIamBindingArgs args, CustomResourceOptions? opts = null)
public ProjectIamBinding(String name, ProjectIamBindingArgs args)
public ProjectIamBinding(String name, ProjectIamBindingArgs args, CustomResourceOptions options)
type: google-native:cloudresourcemanager/v1:ProjectIamBinding
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. ProjectIamBindingArgs
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. ProjectIamBindingArgs
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. ProjectIamBindingArgs
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. ProjectIamBindingArgs
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. ProjectIamBindingArgs
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 projectIamBindingResource = new GoogleNative.CloudResourceManager.V1.ProjectIamBinding("projectIamBindingResource", new()
{
    Members = new[]
    {
        "string",
    },
    Name = "string",
    Role = "string",
    Condition = new GoogleNative.IAM.V1.Inputs.ConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
});
Copy
example, err := cloudresourcemanager.NewProjectIamBinding(ctx, "projectIamBindingResource", &cloudresourcemanager.ProjectIamBindingArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Role: pulumi.String("string"),
	Condition: &iam.ConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
})
Copy
var projectIamBindingResource = new ProjectIamBinding("projectIamBindingResource", ProjectIamBindingArgs.builder()
    .members("string")
    .name("string")
    .role("string")
    .condition(ConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .build());
Copy
project_iam_binding_resource = google_native.cloudresourcemanager.v1.ProjectIamBinding("projectIamBindingResource",
    members=["string"],
    name="string",
    role="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    })
Copy
const projectIamBindingResource = new google_native.cloudresourcemanager.v1.ProjectIamBinding("projectIamBindingResource", {
    members: ["string"],
    name: "string",
    role: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
});
Copy
type: google-native:cloudresourcemanager/v1:ProjectIamBinding
properties:
    condition:
        description: string
        expression: string
        title: string
    members:
        - string
    name: string
    role: string
Copy

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

Members This property is required. List<string>
Identities that will be granted the privilege in role. Each entry can have one of the following values:

  • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
  • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
Name This property is required. string
The name of the resource to manage IAM policies for.
Role This property is required. string
The role that should be applied. Only one IamBinding can be used per role.
Condition Pulumi.GoogleNative.IAM.V1.Inputs.Condition
An IAM Condition for a given binding.
Members This property is required. []string
Identities that will be granted the privilege in role. Each entry can have one of the following values:

  • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
  • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
Name This property is required. string
The name of the resource to manage IAM policies for.
Role This property is required. string
The role that should be applied. Only one IamBinding can be used per role.
Condition ConditionArgs
An IAM Condition for a given binding.
members This property is required. List<String>
Identities that will be granted the privilege in role. Each entry can have one of the following values:

  • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
  • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
name This property is required. String
The name of the resource to manage IAM policies for.
role This property is required. String
The role that should be applied. Only one IamBinding can be used per role.
condition Condition
An IAM Condition for a given binding.
members This property is required. string[]
Identities that will be granted the privilege in role. Each entry can have one of the following values:

  • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
  • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
name This property is required. string
The name of the resource to manage IAM policies for.
role This property is required. string
The role that should be applied. Only one IamBinding can be used per role.
condition iam.v1.Condition
An IAM Condition for a given binding.
members This property is required. Sequence[str]
Identities that will be granted the privilege in role. Each entry can have one of the following values:

  • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
  • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
name This property is required. str
The name of the resource to manage IAM policies for.
role This property is required. str
The role that should be applied. Only one IamBinding can be used per role.
condition iam.v1.ConditionArgs
An IAM Condition for a given binding.
members This property is required. List<String>
Identities that will be granted the privilege in role. Each entry can have one of the following values:

  • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
  • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
name This property is required. String
The name of the resource to manage IAM policies for.
role This property is required. String
The role that should be applied. Only one IamBinding can be used per role.
condition Property Map
An IAM Condition for a given binding.

Outputs

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

Etag string
The etag of the resource's IAM policy.
Id string
The provider-assigned unique ID for this managed resource.
Project string
The project in which the resource belongs. If it is not provided, a default will be supplied.
Etag string
The etag of the resource's IAM policy.
Id string
The provider-assigned unique ID for this managed resource.
Project string
The project in which the resource belongs. If it is not provided, a default will be supplied.
etag String
The etag of the resource's IAM policy.
id String
The provider-assigned unique ID for this managed resource.
project String
The project in which the resource belongs. If it is not provided, a default will be supplied.
etag string
The etag of the resource's IAM policy.
id string
The provider-assigned unique ID for this managed resource.
project string
The project in which the resource belongs. If it is not provided, a default will be supplied.
etag str
The etag of the resource's IAM policy.
id str
The provider-assigned unique ID for this managed resource.
project str
The project in which the resource belongs. If it is not provided, a default will be supplied.
etag String
The etag of the resource's IAM policy.
id String
The provider-assigned unique ID for this managed resource.
project String
The project in which the resource belongs. If it is not provided, a default will be supplied.

Supporting Types

Condition
, ConditionArgs

Expression This property is required. string
Textual representation of an expression in Common Expression Language syntax.
Title This property is required. string
A title for the expression, i.e. a short string describing its purpose.
Description string
An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
Expression This property is required. string
Textual representation of an expression in Common Expression Language syntax.
Title This property is required. string
A title for the expression, i.e. a short string describing its purpose.
Description string
An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
expression This property is required. String
Textual representation of an expression in Common Expression Language syntax.
title This property is required. String
A title for the expression, i.e. a short string describing its purpose.
description String
An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
expression This property is required. string
Textual representation of an expression in Common Expression Language syntax.
title This property is required. string
A title for the expression, i.e. a short string describing its purpose.
description string
An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
expression This property is required. str
Textual representation of an expression in Common Expression Language syntax.
title This property is required. str
A title for the expression, i.e. a short string describing its purpose.
description str
An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.
expression This property is required. String
Textual representation of an expression in Common Expression Language syntax.
title This property is required. String
A title for the expression, i.e. a short string describing its purpose.
description String
An optional description of the expression. This is a longer text which describes the expression, e.g., when hovering over it in a UI.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi