1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. gkebackup
  5. RestorePlanIamPolicy
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

gcp.gkebackup.RestorePlanIamPolicy

Explore with Pulumi AI

Three different resources help you manage your IAM policy for Backup for GKE RestorePlan. Each of these resources serves a different use case:

  • gcp.gkebackup.RestorePlanIamPolicy: Authoritative. Sets the IAM policy for the restoreplan and replaces any existing policy already attached.
  • gcp.gkebackup.RestorePlanIamBinding: 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 restoreplan are preserved.
  • gcp.gkebackup.RestorePlanIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the restoreplan are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

  • gcp.gkebackup.RestorePlanIamPolicy: Retrieves the IAM policy for the restoreplan

Note: gcp.gkebackup.RestorePlanIamPolicy cannot be used in conjunction with gcp.gkebackup.RestorePlanIamBinding and gcp.gkebackup.RestorePlanIamMember or they will fight over what your policy should be.

Note: gcp.gkebackup.RestorePlanIamBinding resources can be used in conjunction with gcp.gkebackup.RestorePlanIamMember resources only if they do not grant privilege to the same role.

gcp.gkebackup.RestorePlanIamPolicy

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.gkebackup.RestorePlanIamPolicy("policy", {
    project: allNs.project,
    location: allNs.location,
    name: allNs.name,
    policyData: admin.then(admin => admin.policyData),
});
Copy
import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.gkebackup.RestorePlanIamPolicy("policy",
    project=all_ns["project"],
    location=all_ns["location"],
    name=all_ns["name"],
    policy_data=admin.policy_data)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = gkebackup.NewRestorePlanIamPolicy(ctx, "policy", &gkebackup.RestorePlanIamPolicyArgs{
			Project:    pulumi.Any(allNs.Project),
			Location:   pulumi.Any(allNs.Location),
			Name:       pulumi.Any(allNs.Name),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
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.GkeBackup.RestorePlanIamPolicy("policy", new()
    {
        Project = allNs.Project,
        Location = allNs.Location,
        Name = allNs.Name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});
Copy
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.gkebackup.RestorePlanIamPolicy;
import com.pulumi.gcp.gkebackup.RestorePlanIamPolicyArgs;
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 RestorePlanIamPolicy("policy", RestorePlanIamPolicyArgs.builder()
            .project(allNs.project())
            .location(allNs.location())
            .name(allNs.name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}
Copy
resources:
  policy:
    type: gcp:gkebackup:RestorePlanIamPolicy
    properties:
      project: ${allNs.project}
      location: ${allNs.location}
      name: ${allNs.name}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com
Copy

gcp.gkebackup.RestorePlanIamBinding

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

const binding = new gcp.gkebackup.RestorePlanIamBinding("binding", {
    project: allNs.project,
    location: allNs.location,
    name: allNs.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});
Copy
import pulumi
import pulumi_gcp as gcp

binding = gcp.gkebackup.RestorePlanIamBinding("binding",
    project=all_ns["project"],
    location=all_ns["location"],
    name=all_ns["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gkebackup.NewRestorePlanIamBinding(ctx, "binding", &gkebackup.RestorePlanIamBindingArgs{
			Project:  pulumi.Any(allNs.Project),
			Location: pulumi.Any(allNs.Location),
			Name:     pulumi.Any(allNs.Name),
			Role:     pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.GkeBackup.RestorePlanIamBinding("binding", new()
    {
        Project = allNs.Project,
        Location = allNs.Location,
        Name = allNs.Name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.gkebackup.RestorePlanIamBinding;
import com.pulumi.gcp.gkebackup.RestorePlanIamBindingArgs;
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 RestorePlanIamBinding("binding", RestorePlanIamBindingArgs.builder()
            .project(allNs.project())
            .location(allNs.location())
            .name(allNs.name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}
Copy
resources:
  binding:
    type: gcp:gkebackup:RestorePlanIamBinding
    properties:
      project: ${allNs.project}
      location: ${allNs.location}
      name: ${allNs.name}
      role: roles/viewer
      members:
        - user:jane@example.com
Copy

gcp.gkebackup.RestorePlanIamMember

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

const member = new gcp.gkebackup.RestorePlanIamMember("member", {
    project: allNs.project,
    location: allNs.location,
    name: allNs.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});
Copy
import pulumi
import pulumi_gcp as gcp

member = gcp.gkebackup.RestorePlanIamMember("member",
    project=all_ns["project"],
    location=all_ns["location"],
    name=all_ns["name"],
    role="roles/viewer",
    member="user:jane@example.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gkebackup.NewRestorePlanIamMember(ctx, "member", &gkebackup.RestorePlanIamMemberArgs{
			Project:  pulumi.Any(allNs.Project),
			Location: pulumi.Any(allNs.Location),
			Name:     pulumi.Any(allNs.Name),
			Role:     pulumi.String("roles/viewer"),
			Member:   pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.GkeBackup.RestorePlanIamMember("member", new()
    {
        Project = allNs.Project,
        Location = allNs.Location,
        Name = allNs.Name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.gkebackup.RestorePlanIamMember;
import com.pulumi.gcp.gkebackup.RestorePlanIamMemberArgs;
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 RestorePlanIamMember("member", RestorePlanIamMemberArgs.builder()
            .project(allNs.project())
            .location(allNs.location())
            .name(allNs.name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}
Copy
resources:
  member:
    type: gcp:gkebackup:RestorePlanIamMember
    properties:
      project: ${allNs.project}
      location: ${allNs.location}
      name: ${allNs.name}
      role: roles/viewer
      member: user:jane@example.com
Copy

This resource supports User Project Overrides.

IAM policy for Backup for GKE RestorePlan

Three different resources help you manage your IAM policy for Backup for GKE RestorePlan. Each of these resources serves a different use case:

  • gcp.gkebackup.RestorePlanIamPolicy: Authoritative. Sets the IAM policy for the restoreplan and replaces any existing policy already attached.
  • gcp.gkebackup.RestorePlanIamBinding: 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 restoreplan are preserved.
  • gcp.gkebackup.RestorePlanIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the restoreplan are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

  • gcp.gkebackup.RestorePlanIamPolicy: Retrieves the IAM policy for the restoreplan

Note: gcp.gkebackup.RestorePlanIamPolicy cannot be used in conjunction with gcp.gkebackup.RestorePlanIamBinding and gcp.gkebackup.RestorePlanIamMember or they will fight over what your policy should be.

Note: gcp.gkebackup.RestorePlanIamBinding resources can be used in conjunction with gcp.gkebackup.RestorePlanIamMember resources only if they do not grant privilege to the same role.

gcp.gkebackup.RestorePlanIamPolicy

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.gkebackup.RestorePlanIamPolicy("policy", {
    project: allNs.project,
    location: allNs.location,
    name: allNs.name,
    policyData: admin.then(admin => admin.policyData),
});
Copy
import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.gkebackup.RestorePlanIamPolicy("policy",
    project=all_ns["project"],
    location=all_ns["location"],
    name=all_ns["name"],
    policy_data=admin.policy_data)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = gkebackup.NewRestorePlanIamPolicy(ctx, "policy", &gkebackup.RestorePlanIamPolicyArgs{
			Project:    pulumi.Any(allNs.Project),
			Location:   pulumi.Any(allNs.Location),
			Name:       pulumi.Any(allNs.Name),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
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.GkeBackup.RestorePlanIamPolicy("policy", new()
    {
        Project = allNs.Project,
        Location = allNs.Location,
        Name = allNs.Name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});
Copy
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.gkebackup.RestorePlanIamPolicy;
import com.pulumi.gcp.gkebackup.RestorePlanIamPolicyArgs;
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 RestorePlanIamPolicy("policy", RestorePlanIamPolicyArgs.builder()
            .project(allNs.project())
            .location(allNs.location())
            .name(allNs.name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}
Copy
resources:
  policy:
    type: gcp:gkebackup:RestorePlanIamPolicy
    properties:
      project: ${allNs.project}
      location: ${allNs.location}
      name: ${allNs.name}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      function: gcp:organizations:getIAMPolicy
      arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com
Copy

gcp.gkebackup.RestorePlanIamBinding

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

const binding = new gcp.gkebackup.RestorePlanIamBinding("binding", {
    project: allNs.project,
    location: allNs.location,
    name: allNs.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});
Copy
import pulumi
import pulumi_gcp as gcp

binding = gcp.gkebackup.RestorePlanIamBinding("binding",
    project=all_ns["project"],
    location=all_ns["location"],
    name=all_ns["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gkebackup.NewRestorePlanIamBinding(ctx, "binding", &gkebackup.RestorePlanIamBindingArgs{
			Project:  pulumi.Any(allNs.Project),
			Location: pulumi.Any(allNs.Location),
			Name:     pulumi.Any(allNs.Name),
			Role:     pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.GkeBackup.RestorePlanIamBinding("binding", new()
    {
        Project = allNs.Project,
        Location = allNs.Location,
        Name = allNs.Name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.gkebackup.RestorePlanIamBinding;
import com.pulumi.gcp.gkebackup.RestorePlanIamBindingArgs;
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 RestorePlanIamBinding("binding", RestorePlanIamBindingArgs.builder()
            .project(allNs.project())
            .location(allNs.location())
            .name(allNs.name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}
Copy
resources:
  binding:
    type: gcp:gkebackup:RestorePlanIamBinding
    properties:
      project: ${allNs.project}
      location: ${allNs.location}
      name: ${allNs.name}
      role: roles/viewer
      members:
        - user:jane@example.com
Copy

gcp.gkebackup.RestorePlanIamMember

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

const member = new gcp.gkebackup.RestorePlanIamMember("member", {
    project: allNs.project,
    location: allNs.location,
    name: allNs.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});
Copy
import pulumi
import pulumi_gcp as gcp

member = gcp.gkebackup.RestorePlanIamMember("member",
    project=all_ns["project"],
    location=all_ns["location"],
    name=all_ns["name"],
    role="roles/viewer",
    member="user:jane@example.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gkebackup.NewRestorePlanIamMember(ctx, "member", &gkebackup.RestorePlanIamMemberArgs{
			Project:  pulumi.Any(allNs.Project),
			Location: pulumi.Any(allNs.Location),
			Name:     pulumi.Any(allNs.Name),
			Role:     pulumi.String("roles/viewer"),
			Member:   pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.GkeBackup.RestorePlanIamMember("member", new()
    {
        Project = allNs.Project,
        Location = allNs.Location,
        Name = allNs.Name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.gkebackup.RestorePlanIamMember;
import com.pulumi.gcp.gkebackup.RestorePlanIamMemberArgs;
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 RestorePlanIamMember("member", RestorePlanIamMemberArgs.builder()
            .project(allNs.project())
            .location(allNs.location())
            .name(allNs.name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}
Copy
resources:
  member:
    type: gcp:gkebackup:RestorePlanIamMember
    properties:
      project: ${allNs.project}
      location: ${allNs.location}
      name: ${allNs.name}
      role: roles/viewer
      member: user:jane@example.com
Copy

Create RestorePlanIamPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RestorePlanIamPolicy(name: string, args: RestorePlanIamPolicyArgs, opts?: CustomResourceOptions);
@overload
def RestorePlanIamPolicy(resource_name: str,
                         args: RestorePlanIamPolicyArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def RestorePlanIamPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         policy_data: Optional[str] = None,
                         location: Optional[str] = None,
                         name: Optional[str] = None,
                         project: Optional[str] = None)
func NewRestorePlanIamPolicy(ctx *Context, name string, args RestorePlanIamPolicyArgs, opts ...ResourceOption) (*RestorePlanIamPolicy, error)
public RestorePlanIamPolicy(string name, RestorePlanIamPolicyArgs args, CustomResourceOptions? opts = null)
public RestorePlanIamPolicy(String name, RestorePlanIamPolicyArgs args)
public RestorePlanIamPolicy(String name, RestorePlanIamPolicyArgs args, CustomResourceOptions options)
type: gcp:gkebackup:RestorePlanIamPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RestorePlanIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RestorePlanIamPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RestorePlanIamPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RestorePlanIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RestorePlanIamPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var restorePlanIamPolicyResource = new Gcp.GkeBackup.RestorePlanIamPolicy("restorePlanIamPolicyResource", new()
{
    PolicyData = "string",
    Location = "string",
    Name = "string",
    Project = "string",
});
Copy
example, err := gkebackup.NewRestorePlanIamPolicy(ctx, "restorePlanIamPolicyResource", &gkebackup.RestorePlanIamPolicyArgs{
	PolicyData: pulumi.String("string"),
	Location:   pulumi.String("string"),
	Name:       pulumi.String("string"),
	Project:    pulumi.String("string"),
})
Copy
var restorePlanIamPolicyResource = new RestorePlanIamPolicy("restorePlanIamPolicyResource", RestorePlanIamPolicyArgs.builder()
    .policyData("string")
    .location("string")
    .name("string")
    .project("string")
    .build());
Copy
restore_plan_iam_policy_resource = gcp.gkebackup.RestorePlanIamPolicy("restorePlanIamPolicyResource",
    policy_data="string",
    location="string",
    name="string",
    project="string")
Copy
const restorePlanIamPolicyResource = new gcp.gkebackup.RestorePlanIamPolicy("restorePlanIamPolicyResource", {
    policyData: "string",
    location: "string",
    name: "string",
    project: "string",
});
Copy
type: gcp:gkebackup:RestorePlanIamPolicy
properties:
    location: string
    name: string
    policyData: string
    project: string
Copy

RestorePlanIamPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RestorePlanIamPolicy resource accepts the following input properties:

PolicyData This property is required. string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
Location Changes to this property will trigger replacement. string
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
Name Changes to this property will trigger replacement. string
Used to find the parent resource to bind the IAM policy to
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
PolicyData This property is required. string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
Location Changes to this property will trigger replacement. string
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
Name Changes to this property will trigger replacement. string
Used to find the parent resource to bind the IAM policy to
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
policyData This property is required. String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
location Changes to this property will trigger replacement. String
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. String
Used to find the parent resource to bind the IAM policy to
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
policyData This property is required. string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
location Changes to this property will trigger replacement. string
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. string
Used to find the parent resource to bind the IAM policy to
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
policy_data This property is required. str
The policy data generated by a gcp.organizations.getIAMPolicy data source.
location Changes to this property will trigger replacement. str
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. str
Used to find the parent resource to bind the IAM policy to
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
policyData This property is required. String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
location Changes to this property will trigger replacement. String
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. String
Used to find the parent resource to bind the IAM policy to
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

Outputs

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

Get an existing RestorePlanIamPolicy 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?: RestorePlanIamPolicyState, opts?: CustomResourceOptions): RestorePlanIamPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        etag: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        policy_data: Optional[str] = None,
        project: Optional[str] = None) -> RestorePlanIamPolicy
func GetRestorePlanIamPolicy(ctx *Context, name string, id IDInput, state *RestorePlanIamPolicyState, opts ...ResourceOption) (*RestorePlanIamPolicy, error)
public static RestorePlanIamPolicy Get(string name, Input<string> id, RestorePlanIamPolicyState? state, CustomResourceOptions? opts = null)
public static RestorePlanIamPolicy get(String name, Output<String> id, RestorePlanIamPolicyState state, CustomResourceOptions options)
resources:  _:    type: gcp:gkebackup:RestorePlanIamPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Etag string
(Computed) The etag of the IAM policy.
Location Changes to this property will trigger replacement. string
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
Name Changes to this property will trigger replacement. string
Used to find the parent resource to bind the IAM policy to
PolicyData string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Etag string
(Computed) The etag of the IAM policy.
Location Changes to this property will trigger replacement. string
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
Name Changes to this property will trigger replacement. string
Used to find the parent resource to bind the IAM policy to
PolicyData string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
etag String
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. String
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. String
Used to find the parent resource to bind the IAM policy to
policyData String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
etag string
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. string
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. string
Used to find the parent resource to bind the IAM policy to
policyData string
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
etag str
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. str
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. str
Used to find the parent resource to bind the IAM policy to
policy_data str
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
etag String
(Computed) The etag of the IAM policy.
location Changes to this property will trigger replacement. String
The region of the Restore Plan. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
name Changes to this property will trigger replacement. String
Used to find the parent resource to bind the IAM policy to
policyData String
The policy data generated by a gcp.organizations.getIAMPolicy data source.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

Import

For all import syntaxes, the “resource in question” can take any of the following forms:

  • projects/{{project}}/locations/{{location}}/restorePlans/{{name}}

  • {{project}}/{{location}}/{{name}}

  • {{location}}/{{name}}

  • {{name}}

Any variables not passed in the import command will be taken from the provider configuration.

Backup for GKE restoreplan 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.

$ pulumi import gcp:gkebackup/restorePlanIamPolicy:RestorePlanIamPolicy editor "projects/{{project}}/locations/{{location}}/restorePlans/{{restore_plan}} roles/viewer user:jane@example.com"
Copy

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

$ pulumi import gcp:gkebackup/restorePlanIamPolicy:RestorePlanIamPolicy editor "projects/{{project}}/locations/{{location}}/restorePlans/{{restore_plan}} roles/viewer"
Copy

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

$ pulumi import gcp:gkebackup/restorePlanIamPolicy:RestorePlanIamPolicy editor projects/{{project}}/locations/{{location}}/restorePlans/{{restore_plan}}
Copy

-> 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.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.