Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. endpoints
  5. ServiceIamBinding
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.endpoints.ServiceIamBinding

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi
pulumi/pulumi-gcp

    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.

    google_endpoints_service_iam_policy

    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: google_endpoints_service.endpoints_service.service_name,
    policyData: admin.then(admin => admin.policyData),
});

    import pulumi
import pulumi_gcp as gcp

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

    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 = google_endpoints_service.Endpoints_service.Service_name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/endpoints"
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_endpoints_service.Endpoints_service.Service_name),
			PolicyData:  *pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(google_endpoints_service.endpoints_service().service_name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

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

    google_endpoints_service_iam_binding

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

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

    import pulumi
import pulumi_gcp as gcp

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

    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 = google_endpoints_service.Endpoints_service.Service_name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(google_endpoints_service.endpoints_service().service_name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}

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

    google_endpoints_service_iam_member

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

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

    import pulumi
import pulumi_gcp as gcp

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

    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 = google_endpoints_service.Endpoints_service.Service_name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_endpoints_service.Endpoints_service.Service_name),
			Role:        pulumi.String("roles/viewer"),
			Member:      pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(google_endpoints_service.endpoints_service().service_name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}

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

    Create ServiceIamBinding Resource

    new ServiceIamBinding(name: string, args: ServiceIamBindingArgs, opts?: CustomResourceOptions);
    @overload
def ServiceIamBinding(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      condition: Optional[ServiceIamBindingConditionArgs] = None,
                      members: Optional[Sequence[str]] = None,
                      role: Optional[str] = None,
                      service_name: Optional[str] = None)
@overload
def ServiceIamBinding(resource_name: str,
                      args: ServiceIamBindingArgs,
                      opts: Optional[ResourceOptions] = 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.
    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.

    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

    The ServiceIamBinding resource accepts the following input properties:

    Members List<string>
    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
    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 ServiceIamBindingConditionArgs
    members List<String>
    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[]
    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 Sequence[str]
    role str

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

    service_name str
    condition ServiceIamBindingConditionArgs
    members List<String>
    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 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)
    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:
    Condition ServiceIamBindingCondition
    Etag string

    (Computed) The etag of the IAM policy.

    Members List<string>
    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 ServiceIamBindingConditionArgs
    Etag string

    (Computed) The etag of the IAM policy.

    Members []string
    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
    etag String

    (Computed) The etag of the IAM policy.

    members List<String>
    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
    etag string

    (Computed) The etag of the IAM policy.

    members string[]
    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 ServiceIamBindingConditionArgs
    etag str

    (Computed) The etag of the IAM policy.

    members Sequence[str]
    role str

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

    service_name str
    condition Property Map
    etag String

    (Computed) The etag of the IAM policy.

    members List<String>
    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

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

    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 v6.67.0 published on Wednesday, Sep 27, 2023 by Pulumi
    pulumi/pulumi-gcp