1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. EnvironmentIamPolicy
Google Cloud Classic v8.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

gcp.apigee.EnvironmentIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Three different resources help you manage your IAM policy for Apigee Environment. Each of these resources serves a different use case:

    • gcp.apigee.EnvironmentIamPolicy: Authoritative. Sets the IAM policy for the environment and replaces any existing policy already attached.
    • gcp.apigee.EnvironmentIamBinding: 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 environment are preserved.
    • gcp.apigee.EnvironmentIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the environment are preserved.

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

    • gcp.apigee.EnvironmentIamPolicy: Retrieves the IAM policy for the environment

    Note: gcp.apigee.EnvironmentIamPolicy cannot be used in conjunction with gcp.apigee.EnvironmentIamBinding and gcp.apigee.EnvironmentIamMember or they will fight over what your policy should be.

    Note: gcp.apigee.EnvironmentIamBinding resources can be used in conjunction with gcp.apigee.EnvironmentIamMember resources only if they do not grant privilege to the same role.

    gcp.apigee.EnvironmentIamPolicy

    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.apigee.EnvironmentIamPolicy("policy", {
        orgId: apigeeEnvironment.orgId,
        envId: apigeeEnvironment.name,
        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.apigee.EnvironmentIamPolicy("policy",
        org_id=apigee_environment["orgId"],
        env_id=apigee_environment["name"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
    	"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 = apigee.NewEnvironmentIamPolicy(ctx, "policy", &apigee.EnvironmentIamPolicyArgs{
    			OrgId:      pulumi.Any(apigeeEnvironment.OrgId),
    			EnvId:      pulumi.Any(apigeeEnvironment.Name),
    			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.Apigee.EnvironmentIamPolicy("policy", new()
        {
            OrgId = apigeeEnvironment.OrgId,
            EnvId = apigeeEnvironment.Name,
            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.apigee.EnvironmentIamPolicy;
    import com.pulumi.gcp.apigee.EnvironmentIamPolicyArgs;
    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 EnvironmentIamPolicy("policy", EnvironmentIamPolicyArgs.builder()
                .orgId(apigeeEnvironment.orgId())
                .envId(apigeeEnvironment.name())
                .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:apigee:EnvironmentIamPolicy
        properties:
          orgId: ${apigeeEnvironment.orgId}
          envId: ${apigeeEnvironment.name}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          Function: gcp:organizations:getIAMPolicy
          Arguments:
            bindings:
              - role: roles/viewer
                members:
                  - user:jane@example.com
    

    gcp.apigee.EnvironmentIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.apigee.EnvironmentIamBinding("binding", {
        orgId: apigeeEnvironment.orgId,
        envId: apigeeEnvironment.name,
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.apigee.EnvironmentIamBinding("binding",
        org_id=apigee_environment["orgId"],
        env_id=apigee_environment["name"],
        role="roles/viewer",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigee.NewEnvironmentIamBinding(ctx, "binding", &apigee.EnvironmentIamBindingArgs{
    			OrgId: pulumi.Any(apigeeEnvironment.OrgId),
    			EnvId: pulumi.Any(apigeeEnvironment.Name),
    			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.Apigee.EnvironmentIamBinding("binding", new()
        {
            OrgId = apigeeEnvironment.OrgId,
            EnvId = apigeeEnvironment.Name,
            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.apigee.EnvironmentIamBinding;
    import com.pulumi.gcp.apigee.EnvironmentIamBindingArgs;
    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 EnvironmentIamBinding("binding", EnvironmentIamBindingArgs.builder()
                .orgId(apigeeEnvironment.orgId())
                .envId(apigeeEnvironment.name())
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:apigee:EnvironmentIamBinding
        properties:
          orgId: ${apigeeEnvironment.orgId}
          envId: ${apigeeEnvironment.name}
          role: roles/viewer
          members:
            - user:jane@example.com
    

    gcp.apigee.EnvironmentIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.apigee.EnvironmentIamMember("member", {
        orgId: apigeeEnvironment.orgId,
        envId: apigeeEnvironment.name,
        role: "roles/viewer",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.apigee.EnvironmentIamMember("member",
        org_id=apigee_environment["orgId"],
        env_id=apigee_environment["name"],
        role="roles/viewer",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigee.NewEnvironmentIamMember(ctx, "member", &apigee.EnvironmentIamMemberArgs{
    			OrgId:  pulumi.Any(apigeeEnvironment.OrgId),
    			EnvId:  pulumi.Any(apigeeEnvironment.Name),
    			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.Apigee.EnvironmentIamMember("member", new()
        {
            OrgId = apigeeEnvironment.OrgId,
            EnvId = apigeeEnvironment.Name,
            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.apigee.EnvironmentIamMember;
    import com.pulumi.gcp.apigee.EnvironmentIamMemberArgs;
    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 EnvironmentIamMember("member", EnvironmentIamMemberArgs.builder()
                .orgId(apigeeEnvironment.orgId())
                .envId(apigeeEnvironment.name())
                .role("roles/viewer")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:apigee:EnvironmentIamMember
        properties:
          orgId: ${apigeeEnvironment.orgId}
          envId: ${apigeeEnvironment.name}
          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 Apigee Environment

    Three different resources help you manage your IAM policy for Apigee Environment. Each of these resources serves a different use case:

    • gcp.apigee.EnvironmentIamPolicy: Authoritative. Sets the IAM policy for the environment and replaces any existing policy already attached.
    • gcp.apigee.EnvironmentIamBinding: 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 environment are preserved.
    • gcp.apigee.EnvironmentIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the environment are preserved.

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

    • gcp.apigee.EnvironmentIamPolicy: Retrieves the IAM policy for the environment

    Note: gcp.apigee.EnvironmentIamPolicy cannot be used in conjunction with gcp.apigee.EnvironmentIamBinding and gcp.apigee.EnvironmentIamMember or they will fight over what your policy should be.

    Note: gcp.apigee.EnvironmentIamBinding resources can be used in conjunction with gcp.apigee.EnvironmentIamMember resources only if they do not grant privilege to the same role.

    gcp.apigee.EnvironmentIamPolicy

    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.apigee.EnvironmentIamPolicy("policy", {
        orgId: apigeeEnvironment.orgId,
        envId: apigeeEnvironment.name,
        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.apigee.EnvironmentIamPolicy("policy",
        org_id=apigee_environment["orgId"],
        env_id=apigee_environment["name"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
    	"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 = apigee.NewEnvironmentIamPolicy(ctx, "policy", &apigee.EnvironmentIamPolicyArgs{
    			OrgId:      pulumi.Any(apigeeEnvironment.OrgId),
    			EnvId:      pulumi.Any(apigeeEnvironment.Name),
    			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.Apigee.EnvironmentIamPolicy("policy", new()
        {
            OrgId = apigeeEnvironment.OrgId,
            EnvId = apigeeEnvironment.Name,
            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.apigee.EnvironmentIamPolicy;
    import com.pulumi.gcp.apigee.EnvironmentIamPolicyArgs;
    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 EnvironmentIamPolicy("policy", EnvironmentIamPolicyArgs.builder()
                .orgId(apigeeEnvironment.orgId())
                .envId(apigeeEnvironment.name())
                .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:apigee:EnvironmentIamPolicy
        properties:
          orgId: ${apigeeEnvironment.orgId}
          envId: ${apigeeEnvironment.name}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          Function: gcp:organizations:getIAMPolicy
          Arguments:
            bindings:
              - role: roles/viewer
                members:
                  - user:jane@example.com
    

    gcp.apigee.EnvironmentIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.apigee.EnvironmentIamBinding("binding", {
        orgId: apigeeEnvironment.orgId,
        envId: apigeeEnvironment.name,
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.apigee.EnvironmentIamBinding("binding",
        org_id=apigee_environment["orgId"],
        env_id=apigee_environment["name"],
        role="roles/viewer",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigee.NewEnvironmentIamBinding(ctx, "binding", &apigee.EnvironmentIamBindingArgs{
    			OrgId: pulumi.Any(apigeeEnvironment.OrgId),
    			EnvId: pulumi.Any(apigeeEnvironment.Name),
    			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.Apigee.EnvironmentIamBinding("binding", new()
        {
            OrgId = apigeeEnvironment.OrgId,
            EnvId = apigeeEnvironment.Name,
            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.apigee.EnvironmentIamBinding;
    import com.pulumi.gcp.apigee.EnvironmentIamBindingArgs;
    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 EnvironmentIamBinding("binding", EnvironmentIamBindingArgs.builder()
                .orgId(apigeeEnvironment.orgId())
                .envId(apigeeEnvironment.name())
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:apigee:EnvironmentIamBinding
        properties:
          orgId: ${apigeeEnvironment.orgId}
          envId: ${apigeeEnvironment.name}
          role: roles/viewer
          members:
            - user:jane@example.com
    

    gcp.apigee.EnvironmentIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.apigee.EnvironmentIamMember("member", {
        orgId: apigeeEnvironment.orgId,
        envId: apigeeEnvironment.name,
        role: "roles/viewer",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.apigee.EnvironmentIamMember("member",
        org_id=apigee_environment["orgId"],
        env_id=apigee_environment["name"],
        role="roles/viewer",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apigee.NewEnvironmentIamMember(ctx, "member", &apigee.EnvironmentIamMemberArgs{
    			OrgId:  pulumi.Any(apigeeEnvironment.OrgId),
    			EnvId:  pulumi.Any(apigeeEnvironment.Name),
    			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.Apigee.EnvironmentIamMember("member", new()
        {
            OrgId = apigeeEnvironment.OrgId,
            EnvId = apigeeEnvironment.Name,
            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.apigee.EnvironmentIamMember;
    import com.pulumi.gcp.apigee.EnvironmentIamMemberArgs;
    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 EnvironmentIamMember("member", EnvironmentIamMemberArgs.builder()
                .orgId(apigeeEnvironment.orgId())
                .envId(apigeeEnvironment.name())
                .role("roles/viewer")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:apigee:EnvironmentIamMember
        properties:
          orgId: ${apigeeEnvironment.orgId}
          envId: ${apigeeEnvironment.name}
          role: roles/viewer
          member: user:jane@example.com
    

    Create EnvironmentIamPolicy Resource

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

    Constructor syntax

    new EnvironmentIamPolicy(name: string, args: EnvironmentIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def EnvironmentIamPolicy(resource_name: str,
                             args: EnvironmentIamPolicyArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def EnvironmentIamPolicy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             env_id: Optional[str] = None,
                             org_id: Optional[str] = None,
                             policy_data: Optional[str] = None)
    func NewEnvironmentIamPolicy(ctx *Context, name string, args EnvironmentIamPolicyArgs, opts ...ResourceOption) (*EnvironmentIamPolicy, error)
    public EnvironmentIamPolicy(string name, EnvironmentIamPolicyArgs args, CustomResourceOptions? opts = null)
    public EnvironmentIamPolicy(String name, EnvironmentIamPolicyArgs args)
    public EnvironmentIamPolicy(String name, EnvironmentIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:apigee:EnvironmentIamPolicy
    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 EnvironmentIamPolicyArgs
    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 EnvironmentIamPolicyArgs
    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 EnvironmentIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentIamPolicyArgs
    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 environmentIamPolicyResource = new Gcp.Apigee.EnvironmentIamPolicy("environmentIamPolicyResource", new()
    {
        EnvId = "string",
        OrgId = "string",
        PolicyData = "string",
    });
    
    example, err := apigee.NewEnvironmentIamPolicy(ctx, "environmentIamPolicyResource", &apigee.EnvironmentIamPolicyArgs{
    	EnvId:      pulumi.String("string"),
    	OrgId:      pulumi.String("string"),
    	PolicyData: pulumi.String("string"),
    })
    
    var environmentIamPolicyResource = new EnvironmentIamPolicy("environmentIamPolicyResource", EnvironmentIamPolicyArgs.builder()
        .envId("string")
        .orgId("string")
        .policyData("string")
        .build());
    
    environment_iam_policy_resource = gcp.apigee.EnvironmentIamPolicy("environmentIamPolicyResource",
        env_id="string",
        org_id="string",
        policy_data="string")
    
    const environmentIamPolicyResource = new gcp.apigee.EnvironmentIamPolicy("environmentIamPolicyResource", {
        envId: "string",
        orgId: "string",
        policyData: "string",
    });
    
    type: gcp:apigee:EnvironmentIamPolicy
    properties:
        envId: string
        orgId: string
        policyData: string
    

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

    EnvId string
    Used to find the parent resource to bind the IAM policy to
    OrgId string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    EnvId string
    Used to find the parent resource to bind the IAM policy to
    OrgId string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    envId String
    Used to find the parent resource to bind the IAM policy to
    orgId String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    envId string
    Used to find the parent resource to bind the IAM policy to
    orgId string
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    env_id str
    Used to find the parent resource to bind the IAM policy to
    org_id str
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    envId String
    Used to find the parent resource to bind the IAM policy to
    orgId String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.

    Outputs

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

    Get an existing EnvironmentIamPolicy 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?: EnvironmentIamPolicyState, opts?: CustomResourceOptions): EnvironmentIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            env_id: Optional[str] = None,
            etag: Optional[str] = None,
            org_id: Optional[str] = None,
            policy_data: Optional[str] = None) -> EnvironmentIamPolicy
    func GetEnvironmentIamPolicy(ctx *Context, name string, id IDInput, state *EnvironmentIamPolicyState, opts ...ResourceOption) (*EnvironmentIamPolicy, error)
    public static EnvironmentIamPolicy Get(string name, Input<string> id, EnvironmentIamPolicyState? state, CustomResourceOptions? opts = null)
    public static EnvironmentIamPolicy get(String name, Output<String> id, EnvironmentIamPolicyState 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:
    EnvId string
    Used to find the parent resource to bind the IAM policy to
    Etag string
    (Computed) The etag of the IAM policy.
    OrgId string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    EnvId string
    Used to find the parent resource to bind the IAM policy to
    Etag string
    (Computed) The etag of the IAM policy.
    OrgId string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    envId String
    Used to find the parent resource to bind the IAM policy to
    etag String
    (Computed) The etag of the IAM policy.
    orgId String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    envId string
    Used to find the parent resource to bind the IAM policy to
    etag string
    (Computed) The etag of the IAM policy.
    orgId string
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    env_id str
    Used to find the parent resource to bind the IAM policy to
    etag str
    (Computed) The etag of the IAM policy.
    org_id str
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    envId String
    Used to find the parent resource to bind the IAM policy to
    etag String
    (Computed) The etag of the IAM policy.
    orgId String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.

    Import

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

    • {{org_id}}/environments/{{name}}

    • {{name}}

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

    Apigee environment 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:apigee/environmentIamPolicy:EnvironmentIamPolicy editor "{{org_id}}/environments/{{environment}} 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:apigee/environmentIamPolicy:EnvironmentIamPolicy editor "{{org_id}}/environments/{{environment}} roles/viewer"
    

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

    $ pulumi import gcp:apigee/environmentIamPolicy:EnvironmentIamPolicy editor {{org_id}}/environments/{{environment}}
    

    -> 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 v8.10.0 published on Wednesday, Nov 20, 2024 by Pulumi