Google Cloud v8.27.1, Apr 25 25

Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi

gcp.endpoints.ServiceIamBinding

Explore with Pulumi AI

Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
gcp.endpoints.ServiceIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved.
gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

gcp.endpoints.ServiceIamPolicy: Retrieves the IAM policy for the service

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

gcp.endpoints.ServiceIamPolicy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.endpoints.ServiceIamPolicy("policy", {
    serviceName: endpointsService.serviceName,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.endpoints.ServiceIamPolicy("policy",
    service_name=endpoints_service["serviceName"],
    policy_data=admin.policy_data)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/endpoints"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewServiceIamPolicy(ctx, "policy", &endpoints.ServiceIamPolicyArgs{
			ServiceName: pulumi.Any(endpointsService.ServiceName),
			PolicyData:  pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.Endpoints.ServiceIamPolicy("policy", new()
    {
        ServiceName = endpointsService.ServiceName,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.endpoints.ServiceIamPolicy;
import com.pulumi.gcp.endpoints.ServiceIamPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new ServiceIamPolicy("policy", ServiceIamPolicyArgs.builder()
            .serviceName(endpointsService.serviceName())
            .policyData(admin.policyData())
            .build());

    }
}

resources:
  policy:
    type: gcp:endpoints:ServiceIamPolicy
    properties:
      serviceName: ${endpointsService.serviceName}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com

gcp.endpoints.ServiceIamBinding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.endpoints.ServiceIamBinding("binding", {
    serviceName: endpointsService.serviceName,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.endpoints.ServiceIamBinding("binding",
    service_name=endpoints_service["serviceName"],
    role="roles/viewer",
    members=["user:jane@example.com"])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/endpoints"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := endpoints.NewServiceIamBinding(ctx, "binding", &endpoints.ServiceIamBindingArgs{
			ServiceName: pulumi.Any(endpointsService.ServiceName),
			Role:        pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.Endpoints.ServiceIamBinding("binding", new()
    {
        ServiceName = endpointsService.ServiceName,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.endpoints.ServiceIamBinding;
import com.pulumi.gcp.endpoints.ServiceIamBindingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var binding = new ServiceIamBinding("binding", ServiceIamBindingArgs.builder()
            .serviceName(endpointsService.serviceName())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:endpoints:ServiceIamBinding
    properties:
      serviceName: ${endpointsService.serviceName}
      role: roles/viewer
      members:
        - user:jane@example.com

gcp.endpoints.ServiceIamMember

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.endpoints.ServiceIamMember("member", {
    serviceName: endpointsService.serviceName,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.endpoints.ServiceIamMember("member",
    service_name=endpoints_service["serviceName"],
    role="roles/viewer",
    member="user:jane@example.com")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/endpoints"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := endpoints.NewServiceIamMember(ctx, "member", &endpoints.ServiceIamMemberArgs{
			ServiceName: pulumi.Any(endpointsService.ServiceName),
			Role:        pulumi.String("roles/viewer"),
			Member:      pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.Endpoints.ServiceIamMember("member", new()
    {
        ServiceName = endpointsService.ServiceName,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.endpoints.ServiceIamMember;
import com.pulumi.gcp.endpoints.ServiceIamMemberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var member = new ServiceIamMember("member", ServiceIamMemberArgs.builder()
            .serviceName(endpointsService.serviceName())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:endpoints:ServiceIamMember
    properties:
      serviceName: ${endpointsService.serviceName}
      role: roles/viewer
      member: user:jane@example.com

> 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`.

IAM policy for Cloud Endpoints Service

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
gcp.endpoints.ServiceIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved.
gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

gcp.endpoints.ServiceIamPolicy: Retrieves the IAM policy for the service

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

gcp.endpoints.ServiceIamPolicy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.endpoints.ServiceIamPolicy("policy", {
    serviceName: endpointsService.serviceName,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.endpoints.ServiceIamPolicy("policy",
    service_name=endpoints_service["serviceName"],
    policy_data=admin.policy_data)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/endpoints"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewServiceIamPolicy(ctx, "policy", &endpoints.ServiceIamPolicyArgs{
			ServiceName: pulumi.Any(endpointsService.ServiceName),
			PolicyData:  pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.Endpoints.ServiceIamPolicy("policy", new()
    {
        ServiceName = endpointsService.ServiceName,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.endpoints.ServiceIamPolicy;
import com.pulumi.gcp.endpoints.ServiceIamPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new ServiceIamPolicy("policy", ServiceIamPolicyArgs.builder()
            .serviceName(endpointsService.serviceName())
            .policyData(admin.policyData())
            .build());

    }
}

resources:
  policy:
    type: gcp:endpoints:ServiceIamPolicy
    properties:
      serviceName: ${endpointsService.serviceName}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com

gcp.endpoints.ServiceIamBinding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.endpoints.ServiceIamBinding("binding", {
    serviceName: endpointsService.serviceName,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.endpoints.ServiceIamBinding("binding",
    service_name=endpoints_service["serviceName"],
    role="roles/viewer",
    members=["user:jane@example.com"])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/endpoints"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := endpoints.NewServiceIamBinding(ctx, "binding", &endpoints.ServiceIamBindingArgs{
			ServiceName: pulumi.Any(endpointsService.ServiceName),
			Role:        pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.Endpoints.ServiceIamBinding("binding", new()
    {
        ServiceName = endpointsService.ServiceName,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.endpoints.ServiceIamBinding;
import com.pulumi.gcp.endpoints.ServiceIamBindingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var binding = new ServiceIamBinding("binding", ServiceIamBindingArgs.builder()
            .serviceName(endpointsService.serviceName())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:endpoints:ServiceIamBinding
    properties:
      serviceName: ${endpointsService.serviceName}
      role: roles/viewer
      members:
        - user:jane@example.com

gcp.endpoints.ServiceIamMember

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.endpoints.ServiceIamMember("member", {
    serviceName: endpointsService.serviceName,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.endpoints.ServiceIamMember("member",
    service_name=endpoints_service["serviceName"],
    role="roles/viewer",
    member="user:jane@example.com")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/endpoints"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := endpoints.NewServiceIamMember(ctx, "member", &endpoints.ServiceIamMemberArgs{
			ServiceName: pulumi.Any(endpointsService.ServiceName),
			Role:        pulumi.String("roles/viewer"),
			Member:      pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.Endpoints.ServiceIamMember("member", new()
    {
        ServiceName = endpointsService.ServiceName,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.endpoints.ServiceIamMember;
import com.pulumi.gcp.endpoints.ServiceIamMemberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var member = new ServiceIamMember("member", ServiceIamMemberArgs.builder()
            .serviceName(endpointsService.serviceName())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:endpoints:ServiceIamMember
    properties:
      serviceName: ${endpointsService.serviceName}
      role: roles/viewer
      member: user:jane@example.com

Create ServiceIamBinding Resource

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

Constructor syntax

new ServiceIamBinding(name: string, args: ServiceIamBindingArgs, opts?: CustomResourceOptions);

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

@overload
def ServiceIamBinding(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      members: Optional[Sequence[str]] = None,
                      role: Optional[str] = None,
                      service_name: Optional[str] = None,
                      condition: Optional[ServiceIamBindingConditionArgs] = None)

func NewServiceIamBinding(ctx *Context, name string, args ServiceIamBindingArgs, opts ...ResourceOption) (*ServiceIamBinding, error)

public ServiceIamBinding(string name, ServiceIamBindingArgs args, CustomResourceOptions? opts = null)

public ServiceIamBinding(String name, ServiceIamBindingArgs args)
public ServiceIamBinding(String name, ServiceIamBindingArgs args, CustomResourceOptions options)

type: gcp:endpoints:ServiceIamBinding
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 ServiceIamBindingArgs: 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 ServiceIamBindingArgs: 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 ServiceIamBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ServiceIamBindingArgs: 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 gcpServiceIamBindingResource = new Gcp.Endpoints.ServiceIamBinding("gcpServiceIamBindingResource", new()
{
    Members = new[]
    {
        "string",
    },
    Role = "string",
    ServiceName = "string",
    Condition = new Gcp.Endpoints.Inputs.ServiceIamBindingConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
});

example, err := endpoints.NewServiceIamBinding(ctx, "gcpServiceIamBindingResource", &endpoints.ServiceIamBindingArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Role:        pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Condition: &endpoints.ServiceIamBindingConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
})

var gcpServiceIamBindingResource = new com.pulumi.gcp.endpoints.ServiceIamBinding("gcpServiceIamBindingResource", com.pulumi.gcp.endpoints.ServiceIamBindingArgs.builder()
    .members("string")
    .role("string")
    .serviceName("string")
    .condition(ServiceIamBindingConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .build());

gcp_service_iam_binding_resource = gcp.endpoints.ServiceIamBinding("gcpServiceIamBindingResource",
    members=["string"],
    role="string",
    service_name="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    })

const gcpServiceIamBindingResource = new gcp.endpoints.ServiceIamBinding("gcpServiceIamBindingResource", {
    members: ["string"],
    role: "string",
    serviceName: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
});

type: gcp:endpoints:ServiceIamBinding
properties:
    condition:
        description: string
        expression: string
        title: string
    members:
        - string
    role: string
    serviceName: string

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

Members List<string>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

ServiceName string

Condition ServiceIamBindingCondition

Members []string

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

ServiceName string

Condition ServiceIamBindingConditionArgs

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

serviceName String

condition ServiceIamBindingCondition

members string[]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role string

serviceName string

condition ServiceIamBindingCondition

members Sequence[str]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role str

service_name str

condition ServiceIamBindingConditionArgs

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

serviceName String

condition Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceIamBinding 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 ServiceIamBinding Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[ServiceIamBindingConditionArgs] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        role: Optional[str] = None,
        service_name: Optional[str] = None) -> ServiceIamBinding

func GetServiceIamBinding(ctx *Context, name string, id IDInput, state *ServiceIamBindingState, opts ...ResourceOption) (*ServiceIamBinding, error)

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

public static ServiceIamBinding get(String name, Output<String> id, ServiceIamBindingState state, CustomResourceOptions options)

resources:  _:    type: gcp:endpoints:ServiceIamBinding    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:

Condition ServiceIamBindingCondition

Etag string

(Computed) The etag of the IAM policy.

Members List<string>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

ServiceName string

Condition ServiceIamBindingConditionArgs

Etag string

(Computed) The etag of the IAM policy.

Members []string

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

ServiceName string

condition ServiceIamBindingCondition

etag String

(Computed) The etag of the IAM policy.

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

serviceName String

condition ServiceIamBindingCondition

etag string

(Computed) The etag of the IAM policy.

members string[]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role string

serviceName string

condition ServiceIamBindingConditionArgs

etag str

(Computed) The etag of the IAM policy.

members Sequence[str]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role str

service_name str

condition Property Map

etag String

(Computed) The etag of the IAM policy.

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
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.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

serviceName String

Supporting Types

ServiceIamBindingCondition, ServiceIamBindingConditionArgs

Expression string
Title string
Description string

Expression string
Title string
Description string

expression String
title String
description String

expression string
title string
description string

expression str
title str
description str

expression String
title String
description String

Import

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

services/{{service_name}}
{{service_name}}

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

Cloud Endpoints service 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:endpoints/serviceIamBinding:ServiceIamBinding editor "services/{{service_name}} 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:endpoints/serviceIamBinding:ServiceIamBinding editor "services/{{service_name}} roles/viewer"

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

$ pulumi import gcp:endpoints/serviceIamBinding:ServiceIamBinding editor services/{{service_name}}

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

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

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.

Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.endpoints.ServiceIamBinding

On this page

On this page

gcp.endpoints.ServiceIamPolicy

gcp.endpoints.ServiceIamBinding

gcp.endpoints.ServiceIamMember

> 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`.

IAM policy for Cloud Endpoints Service

gcp.endpoints.ServiceIamPolicy

gcp.endpoints.ServiceIamBinding

gcp.endpoints.ServiceIamMember

Create ServiceIamBinding Resource

Constructor syntax

Parameters

Constructor example

ServiceIamBinding Resource Properties

Inputs

Outputs

Look up Existing ServiceIamBinding Resource

Supporting Types

ServiceIamBindingCondition, ServiceIamBindingConditionArgs

Import

Package Details

On this page

On this page

gcp.endpoints.ServiceIamBinding

On this page

On this page

gcp.endpoints.ServiceIamPolicy

gcp.endpoints.ServiceIamBinding

gcp.endpoints.ServiceIamMember

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

IAM policy for Cloud Endpoints Service

gcp.endpoints.ServiceIamPolicy

gcp.endpoints.ServiceIamBinding

gcp.endpoints.ServiceIamMember

Create ServiceIamBinding Resource

Constructor syntax

Parameters

Constructor example

ServiceIamBinding Resource Properties

Inputs

Outputs

Look up Existing ServiceIamBinding Resource

Supporting Types

ServiceIamBindingCondition, ServiceIamBindingConditionArgs

Import

Package Details

On this page

On this page

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