import * as pulumi from "@pulumi/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 * * ```typescript * 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), * }); * ``` * * ## gcp.apigee.EnvironmentIamBinding * * ```typescript * 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"], * }); * ``` * * ## gcp.apigee.EnvironmentIamMember * * ```typescript * 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", * }); * ``` * * ## > **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 * * ```typescript * 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), * }); * ``` * * ## gcp.apigee.EnvironmentIamBinding * * ```typescript * 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"], * }); * ``` * * ## gcp.apigee.EnvironmentIamMember * * ```typescript * 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 * * 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. * * ```sh * $ 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. * * ```sh * $ 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. * * ```sh * $ 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`. */ export declare class EnvironmentIamPolicy extends pulumi.CustomResource { /** * Get an existing EnvironmentIamPolicy resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: EnvironmentIamPolicyState, opts?: pulumi.CustomResourceOptions): EnvironmentIamPolicy; /** * Returns true if the given object is an instance of EnvironmentIamPolicy. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is EnvironmentIamPolicy; /** * Used to find the parent resource to bind the IAM policy to */ readonly envId: pulumi.Output; /** * (Computed) The etag of the IAM policy. */ readonly etag: pulumi.Output; /** * The Apigee Organization associated with the Apigee environment, * in the format `organizations/{{org_name}}`. * Used to find the parent resource to bind the IAM policy to */ readonly orgId: pulumi.Output; /** * The policy data generated by * a `gcp.organizations.getIAMPolicy` data source. */ readonly policyData: pulumi.Output; /** * Create a EnvironmentIamPolicy resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: EnvironmentIamPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering EnvironmentIamPolicy resources. */ export interface EnvironmentIamPolicyState { /** * Used to find the parent resource to bind the IAM policy to */ envId?: pulumi.Input; /** * (Computed) The etag of the IAM policy. */ etag?: pulumi.Input; /** * The Apigee Organization associated with the Apigee environment, * in the format `organizations/{{org_name}}`. * Used to find the parent resource to bind the IAM policy to */ orgId?: pulumi.Input; /** * The policy data generated by * a `gcp.organizations.getIAMPolicy` data source. */ policyData?: pulumi.Input; } /** * The set of arguments for constructing a EnvironmentIamPolicy resource. */ export interface EnvironmentIamPolicyArgs { /** * Used to find the parent resource to bind the IAM policy to */ envId: pulumi.Input; /** * The Apigee Organization associated with the Apigee environment, * in the format `organizations/{{org_name}}`. * Used to find the parent resource to bind the IAM policy to */ orgId: pulumi.Input; /** * The policy data generated by * a `gcp.organizations.getIAMPolicy` data source. */ policyData: pulumi.Input; }