IAMCustomRole class

Allows management of a customized Cloud IAM project role. For more information see the official documentation and API.

> Warning: Note that custom roles in GCP have the concept of a soft-delete. There are two issues that may arise from this and how roles are propagated. 1) creating a role may involve undeleting and then updating a role with the same name, possibly causing confusing behavior between undelete and update. 2) A deleted role is permanently deleted after 7 days, but it can take up to 30 more days (i.e. between 7 and 37 days after deletion) before the role name is made available again. This means a deleted role that has been deleted for more than 7 days cannot be changed at all by the provider, and new roles cannot share that name.

Example Usage

This snippet creates a customized IAM role.

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

const my_custom_role = new gcp.projects.IAMCustomRole("my-custom-role", {
    roleId: "myCustomRole",
    title: "My Custom Role",
    description: "A description",
    permissions: [
        "iam.roles.list",
        "iam.roles.create",
        "iam.roles.delete",
    ],
});

import pulumi
import pulumi_gcp as gcp

my_custom_role = gcp.projects.IAMCustomRole("my-custom-role",
    role_id="myCustomRole",
    title="My Custom Role",
    description="A description",
    permissions=[
        "iam.roles.list",
        "iam.roles.create",
        "iam.roles.delete",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var my_custom_role = new Gcp.Projects.IAMCustomRole("my-custom-role", new()
    {
        RoleId = "myCustomRole",
        Title = "My Custom Role",
        Description = "A description",
        Permissions = new[]
        {
            "iam.roles.list",
            "iam.roles.create",
            "iam.roles.delete",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := projects.NewIAMCustomRole(ctx, "my-custom-role", &projects.IAMCustomRoleArgs{
			RoleId:      pulumi.String("myCustomRole"),
			Title:       pulumi.String("My Custom Role"),
			Description: pulumi.String("A description"),
			Permissions: pulumi.StringArray{
				pulumi.String("iam.roles.list"),
				pulumi.String("iam.roles.create"),
				pulumi.String("iam.roles.delete"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_projects_iamcustomrole" "my-custom-role" {
  role_id     = "myCustomRole"
  title       = "My Custom Role"
  description = "A description"
  permissions = ["iam.roles.list", "iam.roles.create", "iam.roles.delete"]
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.IAMCustomRole;
import com.pulumi.gcp.projects.IAMCustomRoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 my_custom_role = new IAMCustomRole("my-custom-role", IAMCustomRoleArgs.builder()
            .roleId("myCustomRole")
            .title("My Custom Role")
            .description("A description")
            .permissions(
                "iam.roles.list",
                "iam.roles.create",
                "iam.roles.delete")
            .build());

    }
}

resources:
  my-custom-role:
    type: gcp:projects:IAMCustomRole
    properties:
      roleId: myCustomRole
      title: My Custom Role
      description: A description
      permissions:
        - iam.roles.list
        - iam.roles.create
        - iam.roles.delete

Constructors

IAMCustomRole(String name, {IAMCustomRoleArgs? args, CustomResourceOptions? options}): Creates a new IAMCustomRole. name The Pulumi resource name. args Arguments used to configure this IAMCustomRole. The set of arguments for IAMCustomRole. options Resource options controlling this resource's behavior.
IAMCustomRole.reference(String urn): Creates a typed reference to an existing IAMCustomRole resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deleted ↔ Output<bool>: (Optional) The current deleted state of the role.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: A human-readable description for the role.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
latefinal
permissions ↔ Output<List<String>>: The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.
latefinal
project ↔ Output<String>: The project that the custom role will be created in. Defaults to the provider project configuration.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
roleId ↔ Output<String>: The camel case role id to use for this role. Cannot contain - characters.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
stage ↔ Output<String?>: The current launch stage of the role. Defaults to GA. List of possible stages is here.
latefinal
title ↔ Output<String>: A human-readable title for the role.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {IAMCustomRoleState? state, CustomResourceOptions? options}) → IAMCustomRole: Gets an existing IAMCustomRole resource's state with the given name and id.