Google Cloud (GCP) Classic

v6.39.0 published on Wednesday, Sep 28, 2022 by Pulumi

EnvironmentIamBinding

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.

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.

google_apigee_environment_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.apigee.EnvironmentIamPolicy("policy", {
    orgId: google_apigee_environment.apigee_environment.org_id,
    envId: google_apigee_environment.apigee_environment.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.apigee.EnvironmentIamPolicy("policy",
    org_id=google_apigee_environment["apigee_environment"]["org_id"],
    env_id=google_apigee_environment["apigee_environment"]["name"],
    policy_data=admin.policy_data)
using System.Collections.Generic;
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 = google_apigee_environment.Apigee_environment.Org_id,
        EnvId = google_apigee_environment.Apigee_environment.Name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/apigee"
	"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{
				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(google_apigee_environment.Apigee_environment.Org_id),
			EnvId:      pulumi.Any(google_apigee_environment.Apigee_environment.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.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(google_apigee_environment.apigee_environment().org_id())
            .envId(google_apigee_environment.apigee_environment().name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}
resources:
  policy:
    type: gcp:apigee:EnvironmentIamPolicy
    properties:
      orgId: ${google_apigee_environment.apigee_environment.org_id}
      envId: ${google_apigee_environment.apigee_environment.name}
      policyData: ${admin.policyData}
variables:
  admin:
    Fn::Invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com

google_apigee_environment_iam_binding

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

const binding = new gcp.apigee.EnvironmentIamBinding("binding", {
    orgId: google_apigee_environment.apigee_environment.org_id,
    envId: google_apigee_environment.apigee_environment.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp

binding = gcp.apigee.EnvironmentIamBinding("binding",
    org_id=google_apigee_environment["apigee_environment"]["org_id"],
    env_id=google_apigee_environment["apigee_environment"]["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])
using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.Apigee.EnvironmentIamBinding("binding", new()
    {
        OrgId = google_apigee_environment.Apigee_environment.Org_id,
        EnvId = google_apigee_environment.Apigee_environment.Name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_apigee_environment.Apigee_environment.Org_id),
			EnvId: pulumi.Any(google_apigee_environment.Apigee_environment.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.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(google_apigee_environment.apigee_environment().org_id())
            .envId(google_apigee_environment.apigee_environment().name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}
resources:
  binding:
    type: gcp:apigee:EnvironmentIamBinding
    properties:
      orgId: ${google_apigee_environment.apigee_environment.org_id}
      envId: ${google_apigee_environment.apigee_environment.name}
      role: roles/viewer
      members:
        - user:jane@example.com

google_apigee_environment_iam_member

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

const member = new gcp.apigee.EnvironmentIamMember("member", {
    orgId: google_apigee_environment.apigee_environment.org_id,
    envId: google_apigee_environment.apigee_environment.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp

member = gcp.apigee.EnvironmentIamMember("member",
    org_id=google_apigee_environment["apigee_environment"]["org_id"],
    env_id=google_apigee_environment["apigee_environment"]["name"],
    role="roles/viewer",
    member="user:jane@example.com")
using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.Apigee.EnvironmentIamMember("member", new()
    {
        OrgId = google_apigee_environment.Apigee_environment.Org_id,
        EnvId = google_apigee_environment.Apigee_environment.Name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/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(google_apigee_environment.Apigee_environment.Org_id),
			EnvId:  pulumi.Any(google_apigee_environment.Apigee_environment.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.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(google_apigee_environment.apigee_environment().org_id())
            .envId(google_apigee_environment.apigee_environment().name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}
resources:
  member:
    type: gcp:apigee:EnvironmentIamMember
    properties:
      orgId: ${google_apigee_environment.apigee_environment.org_id}
      envId: ${google_apigee_environment.apigee_environment.name}
      role: roles/viewer
      member: user:jane@example.com

Create a EnvironmentIamBinding Resource

new EnvironmentIamBinding(name: string, args: EnvironmentIamBindingArgs, opts?: CustomResourceOptions);
@overload
def EnvironmentIamBinding(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          condition: Optional[EnvironmentIamBindingConditionArgs] = None,
                          env_id: Optional[str] = None,
                          members: Optional[Sequence[str]] = None,
                          org_id: Optional[str] = None,
                          role: Optional[str] = None)
@overload
def EnvironmentIamBinding(resource_name: str,
                          args: EnvironmentIamBindingArgs,
                          opts: Optional[ResourceOptions] = None)
func NewEnvironmentIamBinding(ctx *Context, name string, args EnvironmentIamBindingArgs, opts ...ResourceOption) (*EnvironmentIamBinding, error)
public EnvironmentIamBinding(string name, EnvironmentIamBindingArgs args, CustomResourceOptions? opts = null)
public EnvironmentIamBinding(String name, EnvironmentIamBindingArgs args)
public EnvironmentIamBinding(String name, EnvironmentIamBindingArgs args, CustomResourceOptions options)
type: gcp:apigee:EnvironmentIamBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EnvironmentIamBindingArgs
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 EnvironmentIamBindingArgs
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 EnvironmentIamBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvironmentIamBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnvironmentIamBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

EnvId string

Used to find the parent resource to bind the IAM policy to

Members List<string>
OrgId string
Role string

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

Condition EnvironmentIamBindingConditionArgs
EnvId string

Used to find the parent resource to bind the IAM policy to

Members []string
OrgId string
Role string

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

Condition EnvironmentIamBindingConditionArgs
envId String

Used to find the parent resource to bind the IAM policy to

members List<String>
orgId String
role String

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

condition EnvironmentIamBindingConditionArgs
envId string

Used to find the parent resource to bind the IAM policy to

members string[]
orgId string
role string

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

condition EnvironmentIamBindingConditionArgs
env_id str

Used to find the parent resource to bind the IAM policy to

members Sequence[str]
org_id str
role str

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

condition EnvironmentIamBindingConditionArgs
envId String

Used to find the parent resource to bind the IAM policy to

members List<String>
orgId String
role String

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

condition Property Map

Outputs

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

Get an existing EnvironmentIamBinding 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?: EnvironmentIamBindingState, opts?: CustomResourceOptions): EnvironmentIamBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[EnvironmentIamBindingConditionArgs] = None,
        env_id: Optional[str] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        org_id: Optional[str] = None,
        role: Optional[str] = None) -> EnvironmentIamBinding
func GetEnvironmentIamBinding(ctx *Context, name string, id IDInput, state *EnvironmentIamBindingState, opts ...ResourceOption) (*EnvironmentIamBinding, error)
public static EnvironmentIamBinding Get(string name, Input<string> id, EnvironmentIamBindingState? state, CustomResourceOptions? opts = null)
public static EnvironmentIamBinding get(String name, Output<String> id, EnvironmentIamBindingState 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 EnvironmentIamBindingConditionArgs
EnvId string

Used to find the parent resource to bind the IAM policy to

Etag string

(Computed) The etag of the IAM policy.

Members List<string>
OrgId string
Role string

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

Condition EnvironmentIamBindingConditionArgs
EnvId string

Used to find the parent resource to bind the IAM policy to

Etag string

(Computed) The etag of the IAM policy.

Members []string
OrgId string
Role string

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

condition EnvironmentIamBindingConditionArgs
envId String

Used to find the parent resource to bind the IAM policy to

etag String

(Computed) The etag of the IAM policy.

members List<String>
orgId String
role String

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

condition EnvironmentIamBindingConditionArgs
envId string

Used to find the parent resource to bind the IAM policy to

etag string

(Computed) The etag of the IAM policy.

members string[]
orgId string
role string

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

condition EnvironmentIamBindingConditionArgs
env_id str

Used to find the parent resource to bind the IAM policy to

etag str

(Computed) The etag of the IAM policy.

members Sequence[str]
org_id str
role str

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

condition Property Map
envId String

Used to find the parent resource to bind the IAM policy to

etag String

(Computed) The etag of the IAM policy.

members List<String>
orgId String
role String

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

Supporting Types

EnvironmentIamBindingCondition

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* {{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 identifiersthe resource in question, the role, and the member identity, e.g.

 $ pulumi import gcp:apigee/environmentIamBinding:EnvironmentIamBinding editor "{{org_id}}/environments/{{environment}} roles/viewer user:jane@example.com"

IAM binding imports use space-delimited identifiersthe resource in question and the role, e.g.

 $ pulumi import gcp:apigee/environmentIamBinding:EnvironmentIamBinding editor "{{org_id}}/environments/{{environment}} roles/viewer"

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

 $ pulumi import gcp:apigee/environmentIamBinding:EnvironmentIamBinding editor {{org_id}}/environments/{{environment}}

-> 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
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.