Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.32.0 published on Wednesday, Jul 20, 2022 by Pulumi

AccountIamPolicy

Three different resources help you manage IAM policies on billing accounts. Each of these resources serves a different use case:

  • gcp.billing.AccountIamPolicy: Authoritative. Sets the IAM policy for the billing accounts and replaces any existing policy already attached.
  • gcp.billing.AccountIamBinding: 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 table are preserved.
  • gcp.billing.AccountIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role of the billing accounts are preserved.

Note: gcp.billing.AccountIamPolicy cannot be used in conjunction with gcp.billing.AccountIamBinding and gcp.billing.AccountIamMember or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the billing account as gcp.billing.AccountIamPolicy replaces the entire policy.

Note: gcp.billing.AccountIamBinding resources can be used in conjunction with gcp.billing.AccountIamMember resources only if they do not grant privilege to the same role.

google_billing_account_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/billing.viewer",
        members: ["user:jane@example.com"],
    }],
});
const editor = new gcp.billing.AccountIamPolicy("editor", {
    billingAccountId: "00AA00-000AAA-00AA0A",
    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/billing.viewer",
    members=["user:jane@example.com"],
)])
editor = gcp.billing.AccountIamPolicy("editor",
    billing_account_id="00AA00-000AAA-00AA0A",
    policy_data=admin.policy_data)
using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var admin = Output.Create(Gcp.Organizations.GetIAMPolicy.InvokeAsync(new Gcp.Organizations.GetIAMPolicyArgs
        {
            Bindings = 
            {
                new Gcp.Organizations.Inputs.GetIAMPolicyBindingArgs
                {
                    Role = "roles/billing.viewer",
                    Members = 
                    {
                        "user:jane@example.com",
                    },
                },
            },
        }));
        var editor = new Gcp.Billing.AccountIamPolicy("editor", new Gcp.Billing.AccountIamPolicyArgs
        {
            BillingAccountId = "00AA00-000AAA-00AA0A",
            PolicyData = admin.Apply(admin => admin.PolicyData),
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/billing"
	"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/billing.viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = billing.NewAccountIamPolicy(ctx, "editor", &billing.AccountIamPolicyArgs{
			BillingAccountId: pulumi.String("00AA00-000AAA-00AA0A"),
			PolicyData:       pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var admin = Output.of(OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/billing.viewer")
                .members("user:jane@example.com")
                .build())
            .build()));

        var editor = new AccountIamPolicy("editor", AccountIamPolicyArgs.builder()        
            .billingAccountId("00AA00-000AAA-00AA0A")
            .policyData(admin.apply(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}
resources:
  editor:
    type: gcp:billing:AccountIamPolicy
    properties:
      billingAccountId: 00AA00-000AAA-00AA0A
      policyData: ${admin.policyData}
variables:
  admin:
    Fn::Invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/billing.viewer
            members:
              - user:jane@example.com

google_billing_account_iam_binding

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

const editor = new gcp.billing.AccountIamBinding("editor", {
    billingAccountId: "00AA00-000AAA-00AA0A",
    members: ["user:jane@example.com"],
    role: "roles/billing.viewer",
});
import pulumi
import pulumi_gcp as gcp

editor = gcp.billing.AccountIamBinding("editor",
    billing_account_id="00AA00-000AAA-00AA0A",
    members=["user:jane@example.com"],
    role="roles/billing.viewer")
using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var editor = new Gcp.Billing.AccountIamBinding("editor", new Gcp.Billing.AccountIamBindingArgs
        {
            BillingAccountId = "00AA00-000AAA-00AA0A",
            Members = 
            {
                "user:jane@example.com",
            },
            Role = "roles/billing.viewer",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/billing"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := billing.NewAccountIamBinding(ctx, "editor", &billing.AccountIamBindingArgs{
			BillingAccountId: pulumi.String("00AA00-000AAA-00AA0A"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
			Role: pulumi.String("roles/billing.viewer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var editor = new AccountIamBinding("editor", AccountIamBindingArgs.builder()        
            .billingAccountId("00AA00-000AAA-00AA0A")
            .members("user:jane@example.com")
            .role("roles/billing.viewer")
            .build());

    }
}
resources:
  editor:
    type: gcp:billing:AccountIamBinding
    properties:
      billingAccountId: 00AA00-000AAA-00AA0A
      members:
        - user:jane@example.com
      role: roles/billing.viewer

google_billing_account_iam_member

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

const editor = new gcp.billing.AccountIamMember("editor", {
    billingAccountId: "00AA00-000AAA-00AA0A",
    member: "user:jane@example.com",
    role: "roles/billing.viewer",
});
import pulumi
import pulumi_gcp as gcp

editor = gcp.billing.AccountIamMember("editor",
    billing_account_id="00AA00-000AAA-00AA0A",
    member="user:jane@example.com",
    role="roles/billing.viewer")
using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var editor = new Gcp.Billing.AccountIamMember("editor", new Gcp.Billing.AccountIamMemberArgs
        {
            BillingAccountId = "00AA00-000AAA-00AA0A",
            Member = "user:jane@example.com",
            Role = "roles/billing.viewer",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/billing"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := billing.NewAccountIamMember(ctx, "editor", &billing.AccountIamMemberArgs{
			BillingAccountId: pulumi.String("00AA00-000AAA-00AA0A"),
			Member:           pulumi.String("user:jane@example.com"),
			Role:             pulumi.String("roles/billing.viewer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var editor = new AccountIamMember("editor", AccountIamMemberArgs.builder()        
            .billingAccountId("00AA00-000AAA-00AA0A")
            .member("user:jane@example.com")
            .role("roles/billing.viewer")
            .build());

    }
}
resources:
  editor:
    type: gcp:billing:AccountIamMember
    properties:
      billingAccountId: 00AA00-000AAA-00AA0A
      member: user:jane@example.com
      role: roles/billing.viewer

Create a AccountIamPolicy Resource

new AccountIamPolicy(name: string, args: AccountIamPolicyArgs, opts?: CustomResourceOptions);
@overload
def AccountIamPolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     billing_account_id: Optional[str] = None,
                     policy_data: Optional[str] = None)
@overload
def AccountIamPolicy(resource_name: str,
                     args: AccountIamPolicyArgs,
                     opts: Optional[ResourceOptions] = None)
func NewAccountIamPolicy(ctx *Context, name string, args AccountIamPolicyArgs, opts ...ResourceOption) (*AccountIamPolicy, error)
public AccountIamPolicy(string name, AccountIamPolicyArgs args, CustomResourceOptions? opts = null)
public AccountIamPolicy(String name, AccountIamPolicyArgs args)
public AccountIamPolicy(String name, AccountIamPolicyArgs args, CustomResourceOptions options)
type: gcp:billing:AccountIamPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

BillingAccountId string

The billing account id.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

BillingAccountId string

The billing account id.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billingAccountId String

The billing account id.

policyData String

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billingAccountId string

The billing account id.

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billing_account_id str

The billing account id.

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billingAccountId String

The billing account id.

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 AccountIamPolicy resource produces the following output properties:

Etag string

(Computed) The etag of the billing account's IAM policy.

Id string

The provider-assigned unique ID for this managed resource.

Etag string

(Computed) The etag of the billing account's IAM policy.

Id string

The provider-assigned unique ID for this managed resource.

etag String

(Computed) The etag of the billing account's IAM policy.

id String

The provider-assigned unique ID for this managed resource.

etag string

(Computed) The etag of the billing account's IAM policy.

id string

The provider-assigned unique ID for this managed resource.

etag str

(Computed) The etag of the billing account's IAM policy.

id str

The provider-assigned unique ID for this managed resource.

etag String

(Computed) The etag of the billing account's IAM policy.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing AccountIamPolicy Resource

Get an existing AccountIamPolicy 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?: AccountIamPolicyState, opts?: CustomResourceOptions): AccountIamPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        billing_account_id: Optional[str] = None,
        etag: Optional[str] = None,
        policy_data: Optional[str] = None) -> AccountIamPolicy
func GetAccountIamPolicy(ctx *Context, name string, id IDInput, state *AccountIamPolicyState, opts ...ResourceOption) (*AccountIamPolicy, error)
public static AccountIamPolicy Get(string name, Input<string> id, AccountIamPolicyState? state, CustomResourceOptions? opts = null)
public static AccountIamPolicy get(String name, Output<String> id, AccountIamPolicyState 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:
BillingAccountId string

The billing account id.

Etag string

(Computed) The etag of the billing account's IAM policy.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

BillingAccountId string

The billing account id.

Etag string

(Computed) The etag of the billing account's IAM policy.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billingAccountId String

The billing account id.

etag String

(Computed) The etag of the billing account's IAM policy.

policyData String

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billingAccountId string

The billing account id.

etag string

(Computed) The etag of the billing account's IAM policy.

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billing_account_id str

The billing account id.

etag str

(Computed) The etag of the billing account's IAM policy.

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

billingAccountId String

The billing account id.

etag String

(Computed) The etag of the billing account's IAM policy.

policyData String

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Import

Instance IAM resources can be imported using the project, table name, role and/or member.

 $ pulumi import gcp:billing/accountIamPolicy:AccountIamPolicy binding "your-billing-account-id"
 $ pulumi import gcp:billing/accountIamPolicy:AccountIamPolicy binding "your-billing-account-id roles/billing.user"
 $ pulumi import gcp:billing/accountIamPolicy:AccountIamPolicy binding "your-billing-account-id roles/billing.user user:jane@example.com"

-> 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. organizations/my-org-id/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.