1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. endpoints
  5. ServiceIamPolicy
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.endpoints.ServiceIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    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: endpointsService.serviceName,
        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=endpoints_service["serviceName"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/endpoints"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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.applyValue(getIAMPolicyResult -> getIAMPolicyResult.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
    

    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: 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/v7/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
    

    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: 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/v7/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 ServiceIamPolicy Resource

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

    Constructor syntax

    new ServiceIamPolicy(name: string, args: ServiceIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceIamPolicy(resource_name: str,
                         args: ServiceIamPolicyArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceIamPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         policy_data: Optional[str] = None,
                         service_name: Optional[str] = None)
    func NewServiceIamPolicy(ctx *Context, name string, args ServiceIamPolicyArgs, opts ...ResourceOption) (*ServiceIamPolicy, error)
    public ServiceIamPolicy(string name, ServiceIamPolicyArgs args, CustomResourceOptions? opts = null)
    public ServiceIamPolicy(String name, ServiceIamPolicyArgs args)
    public ServiceIamPolicy(String name, ServiceIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:endpoints:ServiceIamPolicy
    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 ServiceIamPolicyArgs
    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 ServiceIamPolicyArgs
    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 ServiceIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceIamPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var gcpServiceIamPolicyResource = new Gcp.Endpoints.ServiceIamPolicy("gcpServiceIamPolicyResource", new()
    {
        PolicyData = "string",
        ServiceName = "string",
    });
    
    example, err := endpoints.NewServiceIamPolicy(ctx, "gcpServiceIamPolicyResource", &endpoints.ServiceIamPolicyArgs{
    	PolicyData:  pulumi.String("string"),
    	ServiceName: pulumi.String("string"),
    })
    
    var gcpServiceIamPolicyResource = new ServiceIamPolicy("gcpServiceIamPolicyResource", ServiceIamPolicyArgs.builder()        
        .policyData("string")
        .serviceName("string")
        .build());
    
    gcp_service_iam_policy_resource = gcp.endpoints.ServiceIamPolicy("gcpServiceIamPolicyResource",
        policy_data="string",
        service_name="string")
    
    const gcpServiceIamPolicyResource = new gcp.endpoints.ServiceIamPolicy("gcpServiceIamPolicyResource", {
        policyData: "string",
        serviceName: "string",
    });
    
    type: gcp:endpoints:ServiceIamPolicy
    properties:
        policyData: string
        serviceName: string
    

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

    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName string
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    service_name str
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String

    Outputs

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

    Get an existing ServiceIamPolicy 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?: ServiceIamPolicyState, opts?: CustomResourceOptions): ServiceIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            etag: Optional[str] = None,
            policy_data: Optional[str] = None,
            service_name: Optional[str] = None) -> ServiceIamPolicy
    func GetServiceIamPolicy(ctx *Context, name string, id IDInput, state *ServiceIamPolicyState, opts ...ResourceOption) (*ServiceIamPolicy, error)
    public static ServiceIamPolicy Get(string name, Input<string> id, ServiceIamPolicyState? state, CustomResourceOptions? opts = null)
    public static ServiceIamPolicy get(String name, Output<String> id, ServiceIamPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    ServiceName string
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName String
    etag string
    (Computed) The etag of the IAM policy.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName string
    etag str
    (Computed) The etag of the IAM policy.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    service_name str
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    serviceName 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/serviceIamPolicy:ServiceIamPolicy 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/serviceIamPolicy:ServiceIamPolicy editor "services/{{service_name}} roles/viewer"
    

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

    $ pulumi import gcp:endpoints/serviceIamPolicy:ServiceIamPolicy 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.
    gcp logo
    Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi