Package com.pulumi.gcp.folder

Class IAMPolicy

  • public class IAMPolicy
extends com.pulumi.resources.CustomResource
    Four different resources help you manage your IAM policy for a folder. Each of these resources serves a different use case: * `gcp.folder.IAMPolicy`: Authoritative. Sets the IAM policy for the folder and replaces any existing policy already attached. * `gcp.folder.IAMBinding`: 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 folder are preserved. * `gcp.folder.IAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the folder are preserved. * `gcp.folder.IamAuditConfig`: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service. > **Note:** `gcp.folder.IAMPolicy` **cannot** be used in conjunction with `gcp.folder.IAMBinding`, `gcp.folder.IAMMember`, or `gcp.folder.IamAuditConfig` or they will fight over what your policy should be. > **Note:** `gcp.folder.IAMBinding` resources **can be** used in conjunction with `gcp.folder.IAMMember` resources **only if** they do not grant privilege to the same role. > **Note:** The underlying API method `projects.setIamPolicy` has constraints which are documented [here](https://cloud.google.com/resource-manager/reference/rest/v1/projects/setIamPolicy). In addition to these constraints, IAM Conditions cannot be used with Basic Roles such as Owner. Violating these constraints will result in the API returning a 400 error code so please review these if you encounter errors with this resource. ## google\_folder\_iam\_policy !> **Be careful!** You can accidentally lock yourself out of your folder using this resource. Deleting a `gcp.folder.IAMPolicy` removes access from anyone without permissions on its parent folder/organization. Proceed with caution. It's not recommended to use `gcp.folder.IAMPolicy` with your provider folder to avoid locking yourself out, and it should generally only be used with folders fully managed by this provider. If you do use this resource, it is recommended to **import** the policy before applying the change. ```java 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.folder.IAMPolicy; import com.pulumi.gcp.folder.IAMPolicyArgs; 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/editor") .members("user:[email protected]") .build()) .build()); var folder = new IAMPolicy("folder", IAMPolicyArgs.builder() .folder("folders/1234567") .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData())) .build()); } } ``` With IAM Conditions: ```java 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.folder.IAMPolicy; import com.pulumi.gcp.folder.IAMPolicyArgs; 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() .condition(GetIAMPolicyBindingConditionArgs.builder() .description("Expiring at midnight of 2019-12-31") .expression("request.time < timestamp(\"2020-01-01T00:00:00Z\")") .title("expires_after_2019_12_31") .build()) .members("user:[email protected]") .role("roles/compute.admin") .build()) .build()); var folder = new IAMPolicy("folder", IAMPolicyArgs.builder() .folder("folders/1234567") .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData())) .build()); } } ``` ## google\_folder\_iam\_binding ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.folder.IAMBinding; import com.pulumi.gcp.folder.IAMBindingArgs; 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 folder = new IAMBinding("folder", IAMBindingArgs.builder() .folder("folders/1234567") .members("user:[email protected]") .role("roles/editor") .build()); } } ``` With IAM Conditions: ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.folder.IAMBinding; import com.pulumi.gcp.folder.IAMBindingArgs; import com.pulumi.gcp.folder.inputs.IAMBindingConditionArgs; 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 folder = new IAMBinding("folder", IAMBindingArgs.builder() .condition(IAMBindingConditionArgs.builder() .description("Expiring at midnight of 2019-12-31") .expression("request.time < timestamp(\"2020-01-01T00:00:00Z\")") .title("expires_after_2019_12_31") .build()) .folder("folders/1234567") .members("user:[email protected]") .role("roles/container.admin") .build()); } } ``` ## google\_folder\_iam\_member ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.folder.IAMMember; import com.pulumi.gcp.folder.IAMMemberArgs; 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 folder = new IAMMember("folder", IAMMemberArgs.builder() .folder("folders/1234567") .member("user:[email protected]") .role("roles/editor") .build()); } } ``` With IAM Conditions: ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.folder.IAMMember; import com.pulumi.gcp.folder.IAMMemberArgs; import com.pulumi.gcp.folder.inputs.IAMMemberConditionArgs; 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 folder = new IAMMember("folder", IAMMemberArgs.builder() .condition(IAMMemberConditionArgs.builder() .description("Expiring at midnight of 2019-12-31") .expression("request.time < timestamp(\"2020-01-01T00:00:00Z\")") .title("expires_after_2019_12_31") .build()) .folder("folders/1234567") .member("user:[email protected]") .role("roles/firebase.admin") .build()); } } ``` ## google\_folder\_iam\_audit\_config ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.folder.IamAuditConfig; import com.pulumi.gcp.folder.IamAuditConfigArgs; import com.pulumi.gcp.folder.inputs.IamAuditConfigAuditLogConfigArgs; 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 folder = new IamAuditConfig("folder", IamAuditConfigArgs.builder() .auditLogConfigs( IamAuditConfigAuditLogConfigArgs.builder() .logType("ADMIN_READ") .build(), IamAuditConfigAuditLogConfigArgs.builder() .exemptedMembers("user:[email protected]") .logType("DATA_READ") .build()) .folder("folders/1234567") .service("allServices") .build()); } } ``` ## Import IAM member imports use space-delimited identifiers; the resource in question, the role, and the account. This member resource can be imported using the `folder`, role, and member e.g. ```sh $ pulumi import gcp:folder/iAMPolicy:IAMPolicy my_folder "folder roles/viewer user:[email protected]" ``` IAM binding imports use space-delimited identifiers; the resource in question and the role. This binding resource can be imported using the `folder` and role, e.g. ```sh $ pulumi import gcp:folder/iAMPolicy:IAMPolicy my_folder "folder roles/viewer" ``` IAM policy imports use the identifier of the resource in question. This policy resource can be imported using the `folder`. ```sh $ pulumi import gcp:folder/iAMPolicy:IAMPolicy my_folder folder ``` IAM audit config imports use the identifier of the resource in question and the service, e.g. ```sh $ pulumi import gcp:folder/iAMPolicy:IAMPolicy my_folder "folder foo.googleapis.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. `organizations/{{org_id}}/roles/{{role_id}}`. -> **Conditional IAM Bindings**If you're importing a IAM binding with a condition block, make sure ```sh $ pulumi import gcp:folder/iAMPolicy:IAMPolicy to include the title of condition, e.g. `google_folder_iam_binding.my_folder "folder roles/{{role_id}} condition-title"` ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      IAMPolicy​(java.lang.String name)  
      IAMPolicy​(java.lang.String name, IAMPolicyArgs args)  
      IAMPolicy​(java.lang.String name, IAMPolicyArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> etag()  
      com.pulumi.core.Output<java.lang.String> folder()  
      static IAMPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IAMPolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> policyData()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IAMPolicy

        public IAMPolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IAMPolicy

        public IAMPolicy​(java.lang.String name,
                 IAMPolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IAMPolicy

        public IAMPolicy​(java.lang.String name,
                 IAMPolicyArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • etag

        public com.pulumi.core.Output<java.lang.String> etag()
        Returns:
        (Computed) The etag of the folder's IAM policy.

      • folder

        public com.pulumi.core.Output<java.lang.String> folder()
        Returns:
        The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

      • policyData

        public com.pulumi.core.Output<java.lang.String> policyData()
        Returns:
        The `gcp.organizations.getIAMPolicy` data source that represents the IAM policy that will be applied to the folder. The policy will be merged with any existing policy applied to the folder. Changing this updates the policy. Deleting this removes all policies from the folder, locking out users without folder-level access.

      • get

        public static IAMPolicy get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            IAMPolicyState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.